<a id="mypy-boto3-ec2"></a>
# mypy-boto3-ec2
[](https://pypi.org/project/mypy-boto3-ec2)
[](https://pypi.org/project/mypy-boto3-ec2)
[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ec2/)
[](https://pepy.tech/project/mypy-boto3-ec2)
Type annotations for
[boto3.EC2 1.34.96](https://boto3.amazonaws.com/v1/documentation/api/latest/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-builder 7.24.0](https://github.com/youtype/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-ec2 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ec2/).
See how it helps to find and fix potential bugs:
- [mypy-boto3-ec2](#mypy-boto3-ec2)
- [How to install](#how-to-install)
- [VSCode extension](#vscode-extension)
- [From PyPI with pip](#from-pypi-with-pip)
- [From conda-forge](#from-conda-forge)
- [How to uninstall](#how-to-uninstall)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Emacs](#emacs)
- [Sublime Text](#sublime-text)
- [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)
- [Literals](#literals)
- [Type definitions](#type-definitions)
- [How it works](#how-it-works)
- [What's new](#what's-new)
- [Implemented features](#implemented-features)
- [Latest changes](#latest-changes)
- [Versioning](#versioning)
- [Thank you](#thank-you)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
<a id="how-to-install"></a>
## How to install
<a id="vscode-extension"></a>
### VSCode extension
Add
[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
extension to your VSCode and run `AWS boto3: Quick Start` command.
Click `Modify` and select `boto3 common` and `EC2`.
<a id="from-pypi-with-pip"></a>
### From PyPI with pip
Install `boto3-stubs` for `EC2` service.
```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[ec2]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[ec2]'
# standalone installation
python -m pip install mypy-boto3-ec2
```
<a id="from-conda-forge"></a>
### From conda-forge
Installing `mypy-boto3-ec2` from the `conda-forge` channel can be achieved by
adding `conda-forge` to your channels with:
```bash
conda config --add channels conda-forge
conda config --set channel_priority strict
```
Once the `conda-forge` channel has been enabled, `mypy-boto3-ec2` can be
installed with:
```bash
conda install mypy-boto3-ec2
```
It is possible to list all of the versions of `mypy-boto3-ec2` available on
your platform with:
```bash
conda search mypy-boto3-ec2 --channel conda-forge
```
<a id="how-to-uninstall"></a>
## How to uninstall
```bash
python -m pip uninstall -y mypy-boto3-ec2
```
<a id="usage"></a>
## Usage
<a id="vscode"></a>
### 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 `boto3-stubs[ec2]` in your environment:
```bash
python -m pip install 'boto3-stubs[ec2]'
```
Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.
<a id="pycharm"></a>
### PyCharm
Install `boto3-stubs-lite[ec2]` in your environment:
```bash
python -m pip install 'boto3-stubs-lite[ec2]'`
```
Both type checking and code completion should now work. Explicit type
annotations **are required**.
Use `boto3-stubs` package instead for implicit type discovery.
<a id="emacs"></a>
### Emacs
- Install `boto3-stubs` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[ec2]'
```
- Install [use-package](https://github.com/jwiegley/use-package),
[lsp](https://github.com/emacs-lsp/lsp-mode/),
[company](https://github.com/company-mode/company-mode) and
[flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
```elisp
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
```
- Make sure emacs uses the environment where you have installed `boto3-stubs`
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<a id="sublime-text"></a>
### Sublime Text
- Install `boto3-stubs[ec2]` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs[ec2]'
```
- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<a id="other-ides"></a>
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
should work.
<a id="mypy"></a>
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[ec2]` in your environment:
```bash
python -m pip install 'boto3-stubs[ec2]'`
```
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<a id="pyright"></a>
### pyright
- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[ec2]` in your environment:
```bash
python -m pip install 'boto3-stubs[ec2]'
```
Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.
<a id="explicit-type-annotations"></a>
## Explicit type annotations
<a id="client-annotations"></a>
### Client annotations
`EC2Client` provides annotations for `boto3.client("ec2")`.
```python
from boto3.session import Session
from mypy_boto3_ec2 import EC2Client
client: EC2Client = Session().client("ec2")
# now client usage is checked by mypy and IDE should provide code completion
```
<a id="paginators-annotations"></a>
### Paginators annotations
`mypy_boto3_ec2.paginator` module contains type annotations for all paginators.
```python
from boto3.session import Session
from mypy_boto3_ec2 import EC2Client
from mypy_boto3_ec2.paginator import (
DescribeAddressTransfersPaginator,
DescribeAddressesAttributePaginator,
DescribeAwsNetworkPerformanceMetricSubscriptionsPaginator,
DescribeByoipCidrsPaginator,
DescribeCapacityBlockOfferingsPaginator,
DescribeCapacityReservationFleetsPaginator,
DescribeCapacityReservationsPaginator,
DescribeCarrierGatewaysPaginator,
DescribeClassicLinkInstancesPaginator,
DescribeClientVpnAuthorizationRulesPaginator,
DescribeClientVpnConnectionsPaginator,
DescribeClientVpnEndpointsPaginator,
DescribeClientVpnRoutesPaginator,
DescribeClientVpnTargetNetworksPaginator,
DescribeCoipPoolsPaginator,
DescribeDhcpOptionsPaginator,
DescribeEgressOnlyInternetGatewaysPaginator,
DescribeExportImageTasksPaginator,
DescribeFastLaunchImagesPaginator,
DescribeFastSnapshotRestoresPaginator,
DescribeFleetsPaginator,
DescribeFlowLogsPaginator,
DescribeFpgaImagesPaginator,
DescribeHostReservationOfferingsPaginator,
DescribeHostReservationsPaginator,
DescribeHostsPaginator,
DescribeIamInstanceProfileAssociationsPaginator,
DescribeImagesPaginator,
DescribeImportImageTasksPaginator,
DescribeImportSnapshotTasksPaginator,
DescribeInstanceConnectEndpointsPaginator,
DescribeInstanceCreditSpecificationsPaginator,
DescribeInstanceEventWindowsPaginator,
DescribeInstanceStatusPaginator,
DescribeInstanceTopologyPaginator,
DescribeInstanceTypeOfferingsPaginator,
DescribeInstanceTypesPaginator,
DescribeInstancesPaginator,
DescribeInternetGatewaysPaginator,
DescribeIpamPoolsPaginator,
DescribeIpamResourceDiscoveriesPaginator,
DescribeIpamResourceDiscoveryAssociationsPaginator,
DescribeIpamScopesPaginator,
DescribeIpamsPaginator,
DescribeIpv6PoolsPaginator,
DescribeLaunchTemplateVersionsPaginator,
DescribeLaunchTemplatesPaginator,
DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsPaginator,
DescribeLocalGatewayRouteTableVpcAssociationsPaginator,
DescribeLocalGatewayRouteTablesPaginator,
DescribeLocalGatewayVirtualInterfaceGroupsPaginator,
DescribeLocalGatewayVirtualInterfacesPaginator,
DescribeLocalGatewaysPaginator,
DescribeMacHostsPaginator,
DescribeManagedPrefixListsPaginator,
DescribeMovingAddressesPaginator,
DescribeNatGatewaysPaginator,
DescribeNetworkAclsPaginator,
DescribeNetworkInsightsAccessScopeAnalysesPaginator,
DescribeNetworkInsightsAccessScopesPaginator,
DescribeNetworkInsightsAnalysesPaginator,
DescribeNetworkInsightsPathsPaginator,
DescribeNetworkInterfacePermissionsPaginator,
DescribeNetworkInterfacesPaginator,
DescribePrefixListsPaginator,
DescribePrincipalIdFormatPaginator,
DescribePublicIpv4PoolsPaginator,
DescribeReplaceRootVolumeTasksPaginator,
DescribeReservedInstancesModificationsPaginator,
DescribeReservedInstancesOfferingsPaginator,
DescribeRouteTablesPaginator,
DescribeScheduledInstanceAvailabilityPaginator,
DescribeScheduledInstancesPaginator,
DescribeSecurityGroupRulesPaginator,
DescribeSecurityGroupsPaginator,
DescribeSnapshotTierStatusPaginator,
DescribeSnapshotsPaginator,
DescribeSpotFleetInstancesPaginator,
DescribeSpotFleetRequestsPaginator,
DescribeSpotInstanceRequestsPaginator,
DescribeSpotPriceHistoryPaginator,
DescribeStaleSecurityGroupsPaginator,
DescribeStoreImageTasksPaginator,
DescribeSubnetsPaginator,
DescribeTagsPaginator,
DescribeTrafficMirrorFiltersPaginator,
DescribeTrafficMirrorSessionsPaginator,
DescribeTrafficMirrorTargetsPaginator,
DescribeTransitGatewayAttachmentsPaginator,
DescribeTransitGatewayConnectPeersPaginator,
DescribeTransitGatewayConnectsPaginator,
DescribeTransitGatewayMulticastDomainsPaginator,
DescribeTransitGatewayPeeringAttachmentsPaginator,
DescribeTransitGatewayPolicyTablesPaginator,
DescribeTransitGatewayRouteTableAnnouncementsPaginator,
DescribeTransitGatewayRouteTablesPaginator,
DescribeTransitGatewayVpcAttachmentsPaginator,
DescribeTransitGatewaysPaginator,
DescribeTrunkInterfaceAssociationsPaginator,
DescribeVerifiedAccessEndpointsPaginator,
DescribeVerifiedAccessGroupsPaginator,
DescribeVerifiedAccessInstanceLoggingConfigurationsPaginator,
DescribeVerifiedAccessInstancesPaginator,
DescribeVerifiedAccessTrustProvidersPaginator,
DescribeVolumeStatusPaginator,
DescribeVolumesPaginator,
DescribeVolumesModificationsPaginator,
DescribeVpcClassicLinkDnsSupportPaginator,
DescribeVpcEndpointConnectionNotificationsPaginator,
DescribeVpcEndpointConnectionsPaginator,
DescribeVpcEndpointServiceConfigurationsPaginator,
DescribeVpcEndpointServicePermissionsPaginator,
DescribeVpcEndpointServicesPaginator,
DescribeVpcEndpointsPaginator,
DescribeVpcPeeringConnectionsPaginator,
DescribeVpcsPaginator,
GetAssociatedIpv6PoolCidrsPaginator,
GetAwsNetworkPerformanceDataPaginator,
GetGroupsForCapacityReservationPaginator,
GetInstanceTypesFromInstanceRequirementsPaginator,
GetIpamAddressHistoryPaginator,
GetIpamDiscoveredAccountsPaginator,
GetIpamDiscoveredResourceCidrsPaginator,
GetIpamPoolAllocationsPaginator,
GetIpamPoolCidrsPaginator,
GetIpamResourceCidrsPaginator,
GetManagedPrefixListAssociationsPaginator,
GetManagedPrefixListEntriesPaginator,
GetNetworkInsightsAccessScopeAnalysisFindingsPaginator,
GetSecurityGroupsForVpcPaginator,
GetSpotPlacementScoresPaginator,
GetTransitGatewayAttachmentPropagationsPaginator,
GetTransitGatewayMulticastDomainAssociationsPaginator,
GetTransitGatewayPolicyTableAssociationsPaginator,
GetTransitGatewayPrefixListReferencesPaginator,
GetTransitGatewayRouteTableAssociationsPaginator,
GetTransitGatewayRouteTablePropagationsPaginator,
GetVpnConnectionDeviceTypesPaginator,
ListImagesInRecycleBinPaginator,
ListSnapshotsInRecycleBinPaginator,
SearchLocalGatewayRoutesPaginator,
SearchTransitGatewayMulticastGroupsPaginator,
)
client: EC2Client = Session().client("ec2")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_address_transfers_paginator: DescribeAddressTransfersPaginator = client.get_paginator(
"describe_address_transfers"
)
describe_addresses_attribute_paginator: DescribeAddressesAttributePaginator = client.get_paginator(
"describe_addresses_attribute"
)
describe_aws_network_performance_metric_subscriptions_paginator: (
DescribeAwsNetworkPerformanceMetricSubscriptionsPaginator
) = client.get_paginator("describe_aws_network_performance_metric_subscriptions")
describe_byoip_cidrs_paginator: DescribeByoipCidrsPaginator = client.get_paginator(
"describe_byoip_cidrs"
)
describe_capacity_block_offerings_paginator: DescribeCapacityBlockOfferingsPaginator = (
client.get_paginator("describe_capacity_block_offerings")
)
describe_capacity_reservation_fleets_paginator: DescribeCapacityReservationFleetsPaginator = (
client.get_paginator("describe_capacity_reservation_fleets")
)
describe_capacity_reservations_paginator: DescribeCapacityReservationsPaginator = (
client.get_paginator("describe_capacity_reservations")
)
describe_carrier_gateways_paginator: DescribeCarrierGatewaysPaginator = client.get_paginator(
"describe_carrier_gateways"
)
describe_classic_link_instances_paginator: DescribeClassicLinkInstancesPaginator = (
client.get_paginator("describe_classic_link_instances")
)
describe_client_vpn_authorization_rules_paginator: DescribeClientVpnAuthorizationRulesPaginator = (
client.get_paginator("describe_client_vpn_authorization_rules")
)
describe_client_vpn_connections_paginator: DescribeClientVpnConnectionsPaginator = (
client.get_paginator("describe_client_vpn_connections")
)
describe_client_vpn_endpoints_paginator: DescribeClientVpnEndpointsPaginator = client.get_paginator(
"describe_client_vpn_endpoints"
)
describe_client_vpn_routes_paginator: DescribeClientVpnRoutesPaginator = client.get_paginator(
"describe_client_vpn_routes"
)
describe_client_vpn_target_networks_paginator: DescribeClientVpnTargetNetworksPaginator = (
client.get_paginator("describe_client_vpn_target_networks")
)
describe_coip_pools_paginator: DescribeCoipPoolsPaginator = client.get_paginator(
"describe_coip_pools"
)
describe_dhcp_options_paginator: DescribeDhcpOptionsPaginator = client.get_paginator(
"describe_dhcp_options"
)
describe_egress_only_internet_gateways_paginator: DescribeEgressOnlyInternetGatewaysPaginator = (
client.get_paginator("describe_egress_only_internet_gateways")
)
describe_export_image_tasks_paginator: DescribeExportImageTasksPaginator = client.get_paginator(
"describe_export_image_tasks"
)
describe_fast_launch_images_paginator: DescribeFastLaunchImagesPaginator = client.get_paginator(
"describe_fast_launch_images"
)
describe_fast_snapshot_restores_paginator: DescribeFastSnapshotRestoresPaginator = (
client.get_paginator("describe_fast_snapshot_restores")
)
describe_fleets_paginator: DescribeFleetsPaginator = client.get_paginator("describe_fleets")
describe_flow_logs_paginator: DescribeFlowLogsPaginator = client.get_paginator("describe_flow_logs")
describe_fpga_images_paginator: DescribeFpgaImagesPaginator = client.get_paginator(
"describe_fpga_images"
)
describe_host_reservation_offerings_paginator: DescribeHostReservationOfferingsPaginator = (
client.get_paginator("describe_host_reservation_offerings")
)
describe_host_reservations_paginator: DescribeHostReservationsPaginator = client.get_paginator(
"describe_host_reservations"
)
describe_hosts_paginator: DescribeHostsPaginator = client.get_paginator("describe_hosts")
describe_iam_instance_profile_associations_paginator: (
DescribeIamInstanceProfileAssociationsPaginator
) = client.get_paginator("describe_iam_instance_profile_associations")
describe_images_paginator: DescribeImagesPaginator = client.get_paginator("describe_images")
describe_import_image_tasks_paginator: DescribeImportImageTasksPaginator = client.get_paginator(
"describe_import_image_tasks"
)
describe_import_snapshot_tasks_paginator: DescribeImportSnapshotTasksPaginator = (
client.get_paginator("describe_import_snapshot_tasks")
)
describe_instance_connect_endpoints_paginator: DescribeInstanceConnectEndpointsPaginator = (
client.get_paginator("describe_instance_connect_endpoints")
)
describe_instance_credit_specifications_paginator: DescribeInstanceCreditSpecificationsPaginator = (
client.get_paginator("describe_instance_credit_specifications")
)
describe_instance_event_windows_paginator: DescribeInstanceEventWindowsPaginator = (
client.get_paginator("describe_instance_event_windows")
)
describe_instance_status_paginator: DescribeInstanceStatusPaginator = client.get_paginator(
"describe_instance_status"
)
describe_instance_topology_paginator: DescribeInstanceTopologyPaginator = client.get_paginator(
"describe_instance_topology"
)
describe_instance_type_offerings_paginator: DescribeInstanceTypeOfferingsPaginator = (
client.get_paginator("describe_instance_type_offerings")
)
describe_instance_types_paginator: DescribeInstanceTypesPaginator = client.get_paginator(
"describe_instance_types"
)
describe_instances_paginator: DescribeInstancesPaginator = client.get_paginator(
"describe_instances"
)
describe_internet_gateways_paginator: DescribeInternetGatewaysPaginator = client.get_paginator(
"describe_internet_gateways"
)
describe_ipam_pools_paginator: DescribeIpamPoolsPaginator = client.get_paginator(
"describe_ipam_pools"
)
describe_ipam_resource_discoveries_paginator: DescribeIpamResourceDiscoveriesPaginator = (
client.get_paginator("describe_ipam_resource_discoveries")
)
describe_ipam_resource_discovery_associations_paginator: (
DescribeIpamResourceDiscoveryAssociationsPaginator
) = client.get_paginator("describe_ipam_resource_discovery_associations")
describe_ipam_scopes_paginator: DescribeIpamScopesPaginator = client.get_paginator(
"describe_ipam_scopes"
)
describe_ipams_paginator: DescribeIpamsPaginator = client.get_paginator("describe_ipams")
describe_ipv6_pools_paginator: DescribeIpv6PoolsPaginator = client.get_paginator(
"describe_ipv6_pools"
)
describe_launch_template_versions_paginator: DescribeLaunchTemplateVersionsPaginator = (
client.get_paginator("describe_launch_template_versions")
)
describe_launch_templates_paginator: DescribeLaunchTemplatesPaginator = client.get_paginator(
"describe_launch_templates"
)
describe_local_gateway_route_table_virtual_interface_group_associations_paginator: (
DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsPaginator
) = client.get_paginator("describe_local_gateway_route_table_virtual_interface_group_associations")
describe_local_gateway_route_table_vpc_associations_paginator: (
DescribeLocalGatewayRouteTableVpcAssociationsPaginator
) = client.get_paginator("describe_local_gateway_route_table_vpc_associations")
describe_local_gateway_route_tables_paginator: DescribeLocalGatewayRouteTablesPaginator = (
client.get_paginator("describe_local_gateway_route_tables")
)
describe_local_gateway_virtual_interface_groups_paginator: (
DescribeLocalGatewayVirtualInterfaceGroupsPaginator
) = client.get_paginator("describe_local_gateway_virtual_interface_groups")
describe_local_gateway_virtual_interfaces_paginator: (
DescribeLocalGatewayVirtualInterfacesPaginator
) = client.get_paginator("describe_local_gateway_virtual_interfaces")
describe_local_gateways_paginator: DescribeLocalGatewaysPaginator = client.get_paginator(
"describe_local_gateways"
)
describe_mac_hosts_paginator: DescribeMacHostsPaginator = client.get_paginator("describe_mac_hosts")
describe_managed_prefix_lists_paginator: DescribeManagedPrefixListsPaginator = client.get_paginator(
"describe_managed_prefix_lists"
)
describe_moving_addresses_paginator: DescribeMovingAddressesPaginator = client.get_paginator(
"describe_moving_addresses"
)
describe_nat_gateways_paginator: DescribeNatGatewaysPaginator = client.get_paginator(
"describe_nat_gateways"
)
describe_network_acls_paginator: DescribeNetworkAclsPaginator = client.get_paginator(
"describe_network_acls"
)
describe_network_insights_access_scope_analyses_paginator: (
DescribeNetworkInsightsAccessScopeAnalysesPaginator
) = client.get_paginator("describe_network_insights_access_scope_analyses")
describe_network_insights_access_scopes_paginator: DescribeNetworkInsightsAccessScopesPaginator = (
client.get_paginator("describe_network_insights_access_scopes")
)
describe_network_insights_analyses_paginator: DescribeNetworkInsightsAnalysesPaginator = (
client.get_paginator("describe_network_insights_analyses")
)
describe_network_insights_paths_paginator: DescribeNetworkInsightsPathsPaginator = (
client.get_paginator("describe_network_insights_paths")
)
describe_network_interface_permissions_paginator: DescribeNetworkInterfacePermissionsPaginator = (
client.get_paginator("describe_network_interface_permissions")
)
describe_network_interfaces_paginator: DescribeNetworkInterfacesPaginator = client.get_paginator(
"describe_network_interfaces"
)
describe_prefix_lists_paginator: DescribePrefixListsPaginator = client.get_paginator(
"describe_prefix_lists"
)
describe_principal_id_format_paginator: DescribePrincipalIdFormatPaginator = client.get_paginator(
"describe_principal_id_format"
)
describe_public_ipv4_pools_paginator: DescribePublicIpv4PoolsPaginator = client.get_paginator(
"describe_public_ipv4_pools"
)
describe_replace_root_volume_tasks_paginator: DescribeReplaceRootVolumeTasksPaginator = (
client.get_paginator("describe_replace_root_volume_tasks")
)
describe_reserved_instances_modifications_paginator: (
DescribeReservedInstancesModificationsPaginator
) = client.get_paginator("describe_reserved_instances_modifications")
describe_reserved_instances_offerings_paginator: DescribeReservedInstancesOfferingsPaginator = (
client.get_paginator("describe_reserved_instances_offerings")
)
describe_route_tables_paginator: DescribeRouteTablesPaginator = client.get_paginator(
"describe_route_tables"
)
describe_scheduled_instance_availability_paginator: (
DescribeScheduledInstanceAvailabilityPaginator
) = client.get_paginator("describe_scheduled_instance_availability")
describe_scheduled_instances_paginator: DescribeScheduledInstancesPaginator = client.get_paginator(
"describe_scheduled_instances"
)
describe_security_group_rules_paginator: DescribeSecurityGroupRulesPaginator = client.get_paginator(
"describe_security_group_rules"
)
describe_security_groups_paginator: DescribeSecurityGroupsPaginator = client.get_paginator(
"describe_security_groups"
)
describe_snapshot_tier_status_paginator: DescribeSnapshotTierStatusPaginator = client.get_paginator(
"describe_snapshot_tier_status"
)
describe_snapshots_paginator: DescribeSnapshotsPaginator = client.get_paginator(
"describe_snapshots"
)
describe_spot_fleet_instances_paginator: DescribeSpotFleetInstancesPaginator = client.get_paginator(
"describe_spot_fleet_instances"
)
describe_spot_fleet_requests_paginator: DescribeSpotFleetRequestsPaginator = client.get_paginator(
"describe_spot_fleet_requests"
)
describe_spot_instance_requests_paginator: DescribeSpotInstanceRequestsPaginator = (
client.get_paginator("describe_spot_instance_requests")
)
describe_spot_price_history_paginator: DescribeSpotPriceHistoryPaginator = client.get_paginator(
"describe_spot_price_history"
)
describe_stale_security_groups_paginator: DescribeStaleSecurityGroupsPaginator = (
client.get_paginator("describe_stale_security_groups")
)
describe_store_image_tasks_paginator: DescribeStoreImageTasksPaginator = client.get_paginator(
"describe_store_image_tasks"
)
describe_subnets_paginator: DescribeSubnetsPaginator = client.get_paginator("describe_subnets")
describe_tags_paginator: DescribeTagsPaginator = client.get_paginator("describe_tags")
describe_traffic_mirror_filters_paginator: DescribeTrafficMirrorFiltersPaginator = (
client.get_paginator("describe_traffic_mirror_filters")
)
describe_traffic_mirror_sessions_paginator: DescribeTrafficMirrorSessionsPaginator = (
client.get_paginator("describe_traffic_mirror_sessions")
)
describe_traffic_mirror_targets_paginator: DescribeTrafficMirrorTargetsPaginator = (
client.get_paginator("describe_traffic_mirror_targets")
)
describe_transit_gateway_attachments_paginator: DescribeTransitGatewayAttachmentsPaginator = (
client.get_paginator("describe_transit_gateway_attachments")
)
describe_transit_gateway_connect_peers_paginator: DescribeTransitGatewayConnectPeersPaginator = (
client.get_paginator("describe_transit_gateway_connect_peers")
)
describe_transit_gateway_connects_paginator: DescribeTransitGatewayConnectsPaginator = (
client.get_paginator("describe_transit_gateway_connects")
)
describe_transit_gateway_multicast_domains_paginator: (
DescribeTransitGatewayMulticastDomainsPaginator
) = client.get_paginator("describe_transit_gateway_multicast_domains")
describe_transit_gateway_peering_attachments_paginator: (
DescribeTransitGatewayPeeringAttachmentsPaginator
) = client.get_paginator("describe_transit_gateway_peering_attachments")
describe_transit_gateway_policy_tables_paginator: DescribeTransitGatewayPolicyTablesPaginator = (
client.get_paginator("describe_transit_gateway_policy_tables")
)
describe_transit_gateway_route_table_announcements_paginator: (
DescribeTransitGatewayRouteTableAnnouncementsPaginator
) = client.get_paginator("describe_transit_gateway_route_table_announcements")
describe_transit_gateway_route_tables_paginator: DescribeTransitGatewayRouteTablesPaginator = (
client.get_paginator("describe_transit_gateway_route_tables")
)
describe_transit_gateway_vpc_attachments_paginator: (
DescribeTransitGatewayVpcAttachmentsPaginator
) = client.get_paginator("describe_transit_gateway_vpc_attachments")
describe_transit_gateways_paginator: DescribeTransitGatewaysPaginator = client.get_paginator(
"describe_transit_gateways"
)
describe_trunk_interface_associations_paginator: DescribeTrunkInterfaceAssociationsPaginator = (
client.get_paginator("describe_trunk_interface_associations")
)
describe_verified_access_endpoints_paginator: DescribeVerifiedAccessEndpointsPaginator = (
client.get_paginator("describe_verified_access_endpoints")
)
describe_verified_access_groups_paginator: DescribeVerifiedAccessGroupsPaginator = (
client.get_paginator("describe_verified_access_groups")
)
describe_verified_access_instance_logging_configurations_paginator: (
DescribeVerifiedAccessInstanceLoggingConfigurationsPaginator
) = client.get_paginator("describe_verified_access_instance_logging_configurations")
describe_verified_access_instances_paginator: DescribeVerifiedAccessInstancesPaginator = (
client.get_paginator("describe_verified_access_instances")
)
describe_verified_access_trust_providers_paginator: (
DescribeVerifiedAccessTrustProvidersPaginator
) = client.get_paginator("describe_verified_access_trust_providers")
describe_volume_status_paginator: DescribeVolumeStatusPaginator = client.get_paginator(
"describe_volume_status"
)
describe_volumes_paginator: DescribeVolumesPaginator = client.get_paginator("describe_volumes")
describe_volumes_modifications_paginator: DescribeVolumesModificationsPaginator = (
client.get_paginator("describe_volumes_modifications")
)
describe_vpc_classic_link_dns_support_paginator: DescribeVpcClassicLinkDnsSupportPaginator = (
client.get_paginator("describe_vpc_classic_link_dns_support")
)
describe_vpc_endpoint_connection_notifications_paginator: (
DescribeVpcEndpointConnectionNotificationsPaginator
) = client.get_paginator("describe_vpc_endpoint_connection_notifications")
describe_vpc_endpoint_connections_paginator: DescribeVpcEndpointConnectionsPaginator = (
client.get_paginator("describe_vpc_endpoint_connections")
)
describe_vpc_endpoint_service_configurations_paginator: (
DescribeVpcEndpointServiceConfigurationsPaginator
) = client.get_paginator("describe_vpc_endpoint_service_configurations")
describe_vpc_endpoint_service_permissions_paginator: (
DescribeVpcEndpointServicePermissionsPaginator
) = client.get_paginator("describe_vpc_endpoint_service_permissions")
describe_vpc_endpoint_services_paginator: DescribeVpcEndpointServicesPaginator = (
client.get_paginator("describe_vpc_endpoint_services")
)
describe_vpc_endpoints_paginator: DescribeVpcEndpointsPaginator = client.get_paginator(
"describe_vpc_endpoints"
)
describe_vpc_peering_connections_paginator: DescribeVpcPeeringConnectionsPaginator = (
client.get_paginator("describe_vpc_peering_connections")
)
describe_vpcs_paginator: DescribeVpcsPaginator = client.get_paginator("describe_vpcs")
get_associated_ipv6_pool_cidrs_paginator: GetAssociatedIpv6PoolCidrsPaginator = (
client.get_paginator("get_associated_ipv6_pool_cidrs")
)
get_aws_network_performance_data_paginator: GetAwsNetworkPerformanceDataPaginator = (
client.get_paginator("get_aws_network_performance_data")
)
get_groups_for_capacity_reservation_paginator: GetGroupsForCapacityReservationPaginator = (
client.get_paginator("get_groups_for_capacity_reservation")
)
get_instance_types_from_instance_requirements_paginator: (
GetInstanceTypesFromInstanceRequirementsPaginator
) = client.get_paginator("get_instance_types_from_instance_requirements")
get_ipam_address_history_paginator: GetIpamAddressHistoryPaginator = client.get_paginator(
"get_ipam_address_history"
)
get_ipam_discovered_accounts_paginator: GetIpamDiscoveredAccountsPaginator = client.get_paginator(
"get_ipam_discovered_accounts"
)
get_ipam_discovered_resource_cidrs_paginator: GetIpamDiscoveredResourceCidrsPaginator = (
client.get_paginator("get_ipam_discovered_resource_cidrs")
)
get_ipam_pool_allocations_paginator: GetIpamPoolAllocationsPaginator = client.get_paginator(
"get_ipam_pool_allocations"
)
get_ipam_pool_cidrs_paginator: GetIpamPoolCidrsPaginator = client.get_paginator(
"get_ipam_pool_cidrs"
)
get_ipam_resource_cidrs_paginator: GetIpamResourceCidrsPaginator = client.get_paginator(
"get_ipam_resource_cidrs"
)
get_managed_prefix_list_associations_paginator: GetManagedPrefixListAssociationsPaginator = (
client.get_paginator("get_managed_prefix_list_associations")
)
get_managed_prefix_list_entries_paginator: GetManagedPrefixListEntriesPaginator = (
client.get_paginator("get_managed_prefix_list_entries")
)
get_network_insights_access_scope_analysis_findings_paginator: (
GetNetworkInsightsAccessScopeAnalysisFindingsPaginator
) = client.get_paginator("get_network_insights_access_scope_analysis_findings")
get_security_groups_for_vpc_paginator: GetSecurityGroupsForVpcPaginator = client.get_paginator(
"get_security_groups_for_vpc"
)
get_spot_placement_scores_paginator: GetSpotPlacementScoresPaginator = client.get_paginator(
"get_spot_placement_scores"
)
get_transit_gateway_attachment_propagations_paginator: (
GetTransitGatewayAttachmentPropagationsPaginator
) = client.get_paginator("get_transit_gateway_attachment_propagations")
get_transit_gateway_multicast_domain_associations_paginator: (
GetTransitGatewayMulticastDomainAssociationsPaginator
) = client.get_paginator("get_transit_gateway_multicast_domain_associations")
get_transit_gateway_policy_table_associations_paginator: (
GetTransitGatewayPolicyTableAssociationsPaginator
) = client.get_paginator("get_transit_gateway_policy_table_associations")
get_transit_gateway_prefix_list_references_paginator: (
GetTransitGatewayPrefixListReferencesPaginator
) = client.get_paginator("get_transit_gateway_prefix_list_references")
get_transit_gateway_route_table_associations_paginator: (
GetTransitGatewayRouteTableAssociationsPaginator
) = client.get_paginator("get_transit_gateway_route_table_associations")
get_transit_gateway_route_table_propagations_paginator: (
GetTransitGatewayRouteTablePropagationsPaginator
) = client.get_paginator("get_transit_gateway_route_table_propagations")
get_vpn_connection_device_types_paginator: GetVpnConnectionDeviceTypesPaginator = (
client.get_paginator("get_vpn_connection_device_types")
)
list_images_in_recycle_bin_paginator: ListImagesInRecycleBinPaginator = client.get_paginator(
"list_images_in_recycle_bin"
)
list_snapshots_in_recycle_bin_paginator: ListSnapshotsInRecycleBinPaginator = client.get_paginator(
"list_snapshots_in_recycle_bin"
)
search_local_gateway_routes_paginator: SearchLocalGatewayRoutesPaginator = client.get_paginator(
"search_local_gateway_routes"
)
search_transit_gateway_multicast_groups_paginator: SearchTransitGatewayMulticastGroupsPaginator = (
client.get_paginator("search_transit_gateway_multicast_groups")
)
```
<a id="waiters-annotations"></a>
### Waiters annotations
`mypy_boto3_ec2.waiter` module contains type annotations for all waiters.
```python
from boto3.session import Session
from mypy_boto3_ec2 import EC2Client
from mypy_boto3_ec2.waiter import (
BundleTaskCompleteWaiter,
ConversionTaskCancelledWaiter,
ConversionTaskCompletedWaiter,
ConversionTaskDeletedWaiter,
CustomerGatewayAvailableWaiter,
ExportTaskCancelledWaiter,
ExportTaskCompletedWaiter,
ImageAvailableWaiter,
ImageExistsWaiter,
InstanceExistsWaiter,
InstanceRunningWaiter,
InstanceStatusOkWaiter,
InstanceStoppedWaiter,
InstanceTerminatedWaiter,
InternetGatewayExistsWaiter,
KeyPairExistsWaiter,
NatGatewayAvailableWaiter,
NatGatewayDeletedWaiter,
NetworkInterfaceAvailableWaiter,
PasswordDataAvailableWaiter,
SecurityGroupExistsWaiter,
SnapshotCompletedWaiter,
SnapshotImportedWaiter,
SpotInstanceRequestFulfilledWaiter,
StoreImageTaskCompleteWaiter,
SubnetAvailableWaiter,
SystemStatusOkWaiter,
VolumeAvailableWaiter,
VolumeDeletedWaiter,
VolumeInUseWaiter,
VpcAvailableWaiter,
VpcExistsWaiter,
VpcPeeringConnectionDeletedWaiter,
VpcPeeringConnectionExistsWaiter,
VpnConnectionAvailableWaiter,
VpnConnectionDeletedWaiter,
)
client: EC2Client = Session().client("ec2")
# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
bundle_task_complete_waiter: BundleTaskCompleteWaiter = client.get_waiter("bundle_task_complete")
conversion_task_cancelled_waiter: ConversionTaskCancelledWaiter = client.get_waiter(
"conversion_task_cancelled"
)
conversion_task_completed_waiter: ConversionTaskCompletedWaiter = client.get_waiter(
"conversion_task_completed"
)
conversion_task_deleted_waiter: ConversionTaskDeletedWaiter = client.get_waiter(
"conversion_task_deleted"
)
customer_gateway_available_waiter: CustomerGatewayAvailableWaiter = client.get_waiter(
"customer_gateway_available"
)
export_task_cancelled_waiter: ExportTaskCancelledWaiter = client.get_waiter("export_task_cancelled")
export_task_completed_waiter: ExportTaskCompletedWaiter = client.get_waiter("export_task_completed")
image_available_waiter: ImageAvailableWaiter = client.get_waiter("image_available")
image_exists_waiter: ImageExistsWaiter = client.get_waiter("image_exists")
instance_exists_waiter: InstanceExistsWaiter = client.get_waiter("instance_exists")
instance_running_waiter: InstanceRunningWaiter = client.get_waiter("instance_running")
instance_status_ok_waiter: InstanceStatusOkWaiter = client.get_waiter("instance_status_ok")
instance_stopped_waiter: InstanceStoppedWaiter = client.get_waiter("instance_stopped")
instance_terminated_waiter: InstanceTerminatedWaiter = client.get_waiter("instance_terminated")
internet_gateway_exists_waiter: InternetGatewayExistsWaiter = client.get_waiter(
"internet_gateway_exists"
)
key_pair_exists_waiter: KeyPairExistsWaiter = client.get_waiter("key_pair_exists")
nat_gateway_available_waiter: NatGatewayAvailableWaiter = client.get_waiter("nat_gateway_available")
nat_gateway_deleted_waiter: NatGatewayDeletedWaiter = client.get_waiter("nat_gateway_deleted")
network_interface_available_waiter: NetworkInterfaceAvailableWaiter = client.get_waiter(
"network_interface_available"
)
password_data_available_waiter: PasswordDataAvailableWaiter = client.get_waiter(
"password_data_available"
)
security_group_exists_waiter: SecurityGroupExistsWaiter = client.get_waiter("security_group_exists")
snapshot_completed_waiter: SnapshotCompletedWaiter = client.get_waiter("snapshot_completed")
snapshot_imported_waiter: SnapshotImportedWaiter = client.get_waiter("snapshot_imported")
spot_instance_request_fulfilled_waiter: SpotInstanceRequestFulfilledWaiter = client.get_waiter(
"spot_instance_request_fulfilled"
)
store_image_task_complete_waiter: StoreImageTaskCompleteWaiter = client.get_waiter(
"store_image_task_complete"
)
subnet_available_waiter: SubnetAvailableWaiter = client.get_waiter("subnet_available")
system_status_ok_waiter: SystemStatusOkWaiter = client.get_waiter("system_status_ok")
volume_available_waiter: VolumeAvailableWaiter = client.get_waiter("volume_available")
volume_deleted_waiter: VolumeDeletedWaiter = client.get_waiter("volume_deleted")
volume_in_use_waiter: VolumeInUseWaiter = client.get_waiter("volume_in_use")
vpc_available_waiter: VpcAvailableWaiter = client.get_waiter("vpc_available")
vpc_exists_waiter: VpcExistsWaiter = client.get_waiter("vpc_exists")
vpc_peering_connection_deleted_waiter: VpcPeeringConnectionDeletedWaiter = client.get_waiter(
"vpc_peering_connection_deleted"
)
vpc_peering_connection_exists_waiter: VpcPeeringConnectionExistsWaiter = client.get_waiter(
"vpc_peering_connection_exists"
)
vpn_connection_available_waiter: VpnConnectionAvailableWaiter = client.get_waiter(
"vpn_connection_available"
)
vpn_connection_deleted_waiter: VpnConnectionDeletedWaiter = client.get_waiter(
"vpn_connection_deleted"
)
```
<a id="service-resource-annotations"></a>
### Service Resource annotations
`EC2ServiceResource` provides annotations for `boto3.resource("ec2")`.
```python
from boto3.session import Session
from mypy_boto3_ec2 import EC2ServiceResource
resource: EC2ServiceResource = Session().resource("ec2")
# now resource usage is checked by mypy and IDE should provide code completion
```
<a id="other-resources-annotations"></a>
### Other resources annotations
`mypy_boto3_ec2.service_resource` module contains type annotations for all
resources.
```python
from boto3.session import Session
from mypy_boto3_ec2 import EC2ServiceResource
from mypy_boto3_ec2.service_resource import (
ClassicAddress,
DhcpOptions,
Image,
Instance,
InternetGateway,
KeyPair,
KeyPairInfo,
NetworkAcl,
NetworkInterface,
NetworkInterfaceAssociation,
PlacementGroup,
Route,
RouteTable,
RouteTableAssociation,
SecurityGroup,
Snapshot,
Subnet,
Tag,
Volume,
Vpc,
VpcPeeringConnection,
VpcAddress,
)
resource: EC2ServiceResource = Session().resource("ec2")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
my_classic_address: ClassicAddress = resource.ClassicAddress(...)
my_dhcp_options: DhcpOptions = resource.DhcpOptions(...)
my_image: Image = resource.Image(...)
my_instance: Instance = resource.Instance(...)
my_internet_gateway: InternetGateway = resource.InternetGateway(...)
my_key_pair: KeyPair = resource.KeyPair(...)
my_key_pair_info: KeyPairInfo = resource.KeyPairInfo(...)
my_network_acl: NetworkAcl = resource.NetworkAcl(...)
my_network_interface: NetworkInterface = resource.NetworkInterface(...)
my_network_interface_association: NetworkInterfaceAssociation = (
resource.NetworkInterfaceAssociation(...)
)
my_placement_group: PlacementGroup = resource.PlacementGroup(...)
my_route: Route = resource.Route(...)
my_route_table: RouteTable = resource.RouteTable(...)
my_route_table_association: RouteTableAssociation = resource.RouteTableAssociation(...)
my_security_group: SecurityGroup = resource.SecurityGroup(...)
my_snapshot: Snapshot = resource.Snapshot(...)
my_subnet: Subnet = resource.Subnet(...)
my_tag: Tag = resource.Tag(...)
my_volume: Volume = resource.Volume(...)
my_vpc: Vpc = resource.Vpc(...)
my_vpc_peering_connection: VpcPeeringConnection = resource.VpcPeeringConnection(...)
my_vpc_address: VpcAddress = resource.VpcAddress(...)
```
<a id="collections-annotations"></a>
### Collections annotations
`mypy_boto3_ec2.service_resource` module contains type annotations for all
`EC2ServiceResource` collections.
```python
from boto3.session import Session
from mypy_boto3_ec2 import EC2ServiceResource
from mypy_boto3_ec2.service_resource import (
ServiceResourceClassicAddressesCollection,
ServiceResourceDhcpOptionsSetsCollection,
ServiceResourceImagesCollection,
ServiceResourceInstancesCollection,
ServiceResourceInternetGatewaysCollection,
ServiceResourceKeyPairsCollection,
ServiceResourceNetworkAclsCollection,
ServiceResourceNetworkInterfacesCollection,
ServiceResourcePlacementGroupsCollection,
ServiceResourceRouteTablesCollection,
ServiceResourceSecurityGroupsCollection,
ServiceResourceSnapshotsCollection,
ServiceResourceSubnetsCollection,
ServiceResourceVolumesCollection,
ServiceResourceVpcAddressesCollection,
ServiceResourceVpcPeeringConnectionsCollection,
ServiceResourceVpcsCollection,
)
resource: EC2ServiceResource = Session().resource("ec2")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
classic_addresses: ec2_resources.ServiceResourceClassicAddressesCollection = (
resource.classic_addresses
)
dhcp_options_sets: ec2_resources.ServiceResourceDhcpOptionsSetsCollection = (
resource.dhcp_options_sets
)
images: ec2_resources.ServiceResourceImagesCollection = resource.images
instances: ec2_resources.ServiceResourceInstancesCollection = resource.instances
internet_gateways: ec2_resources.ServiceResourceInternetGatewaysCollection = (
resource.internet_gateways
)
key_pairs: ec2_resources.ServiceResourceKeyPairsCollection = resource.key_pairs
network_acls: ec2_resources.ServiceResourceNetworkAclsCollection = resource.network_acls
network_interfaces: ec2_resources.ServiceResourceNetworkInterfacesCollection = (
resource.network_interfaces
)
placement_groups: ec2_resources.ServiceResourcePlacementGroupsCollection = resource.placement_groups
route_tables: ec2_resources.ServiceResourceRouteTablesCollection = resource.route_tables
security_groups: ec2_resources.ServiceResourceSecurityGroupsCollection = resource.security_groups
snapshots: ec2_resources.ServiceResourceSnapshotsCollection = resource.snapshots
subnets: ec2_resources.ServiceResourceSubnetsCollection = resource.subnets
volumes: ec2_resources.ServiceResourceVolumesCollection = resource.volumes
vpc_addresses: ec2_resources.ServiceResourceVpcAddressesCollection = resource.vpc_addresses
vpc_peering_connections: ec2_resources.ServiceResourceVpcPeeringConnectionsCollection = (
resource.vpc_peering_connections
)
vpcs: ec2_resources.ServiceResourceVpcsCollection = resource.vpcs
```
<a id="literals"></a>
### Literals
`mypy_boto3_ec2.literals` module contains literals extracted from shapes that
can be used in user code for type checking.
Full list of `EC2` Literals can be found in
[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ec2/literals/).
```python
from mypy_boto3_ec2.literals import AcceleratorManufacturerType
def check_value(value: AcceleratorManufacturerType) -> bool: ...
```
<a id="type-definitions"></a>
### Type definitions
`mypy_boto3_ec2.type_defs` module contains structures and shapes assembled to
typed dictionaries and unions for additional type checking.
Full list of `EC2` TypeDefs can be found in
[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ec2/type_defs/).
```python
from mypy_boto3_ec2.type_defs import AcceleratorCountRequestTypeDef
def get_value() -> AcceleratorCountRequestTypeDef:
return {...}
```
<a id="how-it-works"></a>
## How it works
Fully automated
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for `boto3`
updates. It delivers drop-in type annotations for you and makes sure that:
- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
annotations extracted from `botocore` schemas.
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [black](https://github.com/psf/black) and
[isort](https://github.com/PyCQA/isort) for readability.
<a id="what's-new"></a>
## What's new
<a id="implemented-features"></a>
### Implemented features
- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`
libraries
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
compatibility
- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.resource` calls
- Auto discovery of types for `session.client` and `session.resource` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls
<a id="latest-changes"></a>
### Latest changes
Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).
<a id="versioning"></a>
## Versioning
`mypy-boto3-ec2` version is the same as related `boto3` version and follows
[PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
<a id="thank-you"></a>
## Thank you
- [Allie Fitter](https://github.com/alliefitter) for
[boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
[isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
Python
<a id="documentation"></a>
## Documentation
All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ec2/)
<a id="support-and-contributing"></a>
## Support and contributing
This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
repository.
Raw data
{
"_id": null,
"home_page": "https://github.com/youtype/mypy_boto3_builder",
"name": "mypy-boto3-ec2",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "boto3 ec2 type-annotations botocore mypy typeshed autocomplete",
"author": "Vlad Emelianov",
"author_email": "vlad.emelianov.nz@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/43/19/70abe24616921b2554cf22de4d8dc964e7f59f0ed8706b1d300483752cbe/mypy_boto3_ec2-1.34.96.tar.gz",
"platform": null,
"description": "<a id=\"mypy-boto3-ec2\"></a>\n\n# mypy-boto3-ec2\n\n[](https://pypi.org/project/mypy-boto3-ec2)\n[](https://pypi.org/project/mypy-boto3-ec2)\n[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ec2/)\n[](https://pepy.tech/project/mypy-boto3-ec2)\n\n\n\nType annotations for\n[boto3.EC2 1.34.96](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ec2.html#EC2)\nservice compatible with [VSCode](https://code.visualstudio.com/),\n[PyCharm](https://www.jetbrains.com/pycharm/),\n[Emacs](https://www.gnu.org/software/emacs/),\n[Sublime Text](https://www.sublimetext.com/),\n[mypy](https://github.com/python/mypy),\n[pyright](https://github.com/microsoft/pyright) and other tools.\n\nGenerated by\n[mypy-boto3-builder 7.24.0](https://github.com/youtype/mypy_boto3_builder).\n\nMore information can be found on\n[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in\n[mypy-boto3-ec2 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ec2/).\n\nSee how it helps to find and fix potential bugs:\n\n\n\n- [mypy-boto3-ec2](#mypy-boto3-ec2)\n - [How to install](#how-to-install)\n - [VSCode extension](#vscode-extension)\n - [From PyPI with pip](#from-pypi-with-pip)\n - [From conda-forge](#from-conda-forge)\n - [How to uninstall](#how-to-uninstall)\n - [Usage](#usage)\n - [VSCode](#vscode)\n - [PyCharm](#pycharm)\n - [Emacs](#emacs)\n - [Sublime Text](#sublime-text)\n - [Other IDEs](#other-ides)\n - [mypy](#mypy)\n - [pyright](#pyright)\n - [Explicit type annotations](#explicit-type-annotations)\n - [Client annotations](#client-annotations)\n - [Paginators annotations](#paginators-annotations)\n - [Waiters annotations](#waiters-annotations)\n - [Service Resource annotations](#service-resource-annotations)\n - [Other resources annotations](#other-resources-annotations)\n - [Collections annotations](#collections-annotations)\n - [Literals](#literals)\n - [Type definitions](#type-definitions)\n - [How it works](#how-it-works)\n - [What's new](#what's-new)\n - [Implemented features](#implemented-features)\n - [Latest changes](#latest-changes)\n - [Versioning](#versioning)\n - [Thank you](#thank-you)\n - [Documentation](#documentation)\n - [Support and contributing](#support-and-contributing)\n\n<a id=\"how-to-install\"></a>\n\n## How to install\n\n<a id=\"vscode-extension\"></a>\n\n### VSCode extension\n\nAdd\n[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)\nextension to your VSCode and run `AWS boto3: Quick Start` command.\n\nClick `Modify` and select `boto3 common` and `EC2`.\n\n<a id=\"from-pypi-with-pip\"></a>\n\n### From PyPI with pip\n\nInstall `boto3-stubs` for `EC2` service.\n\n```bash\n# install with boto3 type annotations\npython -m pip install 'boto3-stubs[ec2]'\n\n\n# Lite version does not provide session.client/resource overloads\n# it is more RAM-friendly, but requires explicit type annotations\npython -m pip install 'boto3-stubs-lite[ec2]'\n\n\n# standalone installation\npython -m pip install mypy-boto3-ec2\n```\n\n<a id=\"from-conda-forge\"></a>\n\n### From conda-forge\n\nInstalling `mypy-boto3-ec2` from the `conda-forge` channel can be achieved by\nadding `conda-forge` to your channels with:\n\n```bash\nconda config --add channels conda-forge\nconda config --set channel_priority strict\n```\n\nOnce the `conda-forge` channel has been enabled, `mypy-boto3-ec2` can be\ninstalled with:\n\n```bash\nconda install mypy-boto3-ec2\n```\n\nIt is possible to list all of the versions of `mypy-boto3-ec2` available on\nyour platform with:\n\n```bash\nconda search mypy-boto3-ec2 --channel conda-forge\n```\n\n<a id=\"how-to-uninstall\"></a>\n\n## How to uninstall\n\n```bash\npython -m pip uninstall -y mypy-boto3-ec2\n```\n\n<a id=\"usage\"></a>\n\n## Usage\n\n<a id=\"vscode\"></a>\n\n### VSCode\n\n- Install\n [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)\n- Install\n [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)\n- Set `Pylance` as your Python Language Server\n- Install `boto3-stubs[ec2]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[ec2]'\n```\n\nBoth type checking and code completion should now work. No explicit type\nannotations required, write your `boto3` code as usual.\n\n<a id=\"pycharm\"></a>\n\n### PyCharm\n\nInstall `boto3-stubs-lite[ec2]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs-lite[ec2]'`\n```\n\nBoth type checking and code completion should now work. Explicit type\nannotations **are required**.\n\nUse `boto3-stubs` package instead for implicit type discovery.\n\n<a id=\"emacs\"></a>\n\n### Emacs\n\n- Install `boto3-stubs` with services you use in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[ec2]'\n```\n\n- Install [use-package](https://github.com/jwiegley/use-package),\n [lsp](https://github.com/emacs-lsp/lsp-mode/),\n [company](https://github.com/company-mode/company-mode) and\n [flycheck](https://github.com/flycheck/flycheck) packages\n- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package\n\n```elisp\n(use-package lsp-pyright\n :ensure t\n :hook (python-mode . (lambda ()\n (require 'lsp-pyright)\n (lsp))) ; or lsp-deferred\n :init (when (executable-find \"python3\")\n (setq lsp-pyright-python-executable-cmd \"python3\"))\n )\n```\n\n- Make sure emacs uses the environment where you have installed `boto3-stubs`\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"sublime-text\"></a>\n\n### Sublime Text\n\n- Install `boto3-stubs[ec2]` with services you use in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[ec2]'\n```\n\n- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"other-ides\"></a>\n\n### Other IDEs\n\nNot tested, but as long as your IDE supports `mypy` or `pyright`, everything\nshould work.\n\n<a id=\"mypy\"></a>\n\n### mypy\n\n- Install `mypy`: `python -m pip install mypy`\n- Install `boto3-stubs[ec2]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[ec2]'`\n```\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"pyright\"></a>\n\n### pyright\n\n- Install `pyright`: `npm i -g pyright`\n- Install `boto3-stubs[ec2]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[ec2]'\n```\n\nOptionally, you can install `boto3-stubs` to `typings` folder.\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"explicit-type-annotations\"></a>\n\n## Explicit type annotations\n\n<a id=\"client-annotations\"></a>\n\n### Client annotations\n\n`EC2Client` provides annotations for `boto3.client(\"ec2\")`.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_ec2 import EC2Client\n\nclient: EC2Client = Session().client(\"ec2\")\n\n# now client usage is checked by mypy and IDE should provide code completion\n```\n\n<a id=\"paginators-annotations\"></a>\n\n### Paginators annotations\n\n`mypy_boto3_ec2.paginator` module contains type annotations for all paginators.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_ec2 import EC2Client\nfrom mypy_boto3_ec2.paginator import (\n DescribeAddressTransfersPaginator,\n DescribeAddressesAttributePaginator,\n DescribeAwsNetworkPerformanceMetricSubscriptionsPaginator,\n DescribeByoipCidrsPaginator,\n DescribeCapacityBlockOfferingsPaginator,\n DescribeCapacityReservationFleetsPaginator,\n DescribeCapacityReservationsPaginator,\n DescribeCarrierGatewaysPaginator,\n DescribeClassicLinkInstancesPaginator,\n DescribeClientVpnAuthorizationRulesPaginator,\n DescribeClientVpnConnectionsPaginator,\n DescribeClientVpnEndpointsPaginator,\n DescribeClientVpnRoutesPaginator,\n DescribeClientVpnTargetNetworksPaginator,\n DescribeCoipPoolsPaginator,\n DescribeDhcpOptionsPaginator,\n DescribeEgressOnlyInternetGatewaysPaginator,\n DescribeExportImageTasksPaginator,\n DescribeFastLaunchImagesPaginator,\n DescribeFastSnapshotRestoresPaginator,\n DescribeFleetsPaginator,\n DescribeFlowLogsPaginator,\n DescribeFpgaImagesPaginator,\n DescribeHostReservationOfferingsPaginator,\n DescribeHostReservationsPaginator,\n DescribeHostsPaginator,\n DescribeIamInstanceProfileAssociationsPaginator,\n DescribeImagesPaginator,\n DescribeImportImageTasksPaginator,\n DescribeImportSnapshotTasksPaginator,\n DescribeInstanceConnectEndpointsPaginator,\n DescribeInstanceCreditSpecificationsPaginator,\n DescribeInstanceEventWindowsPaginator,\n DescribeInstanceStatusPaginator,\n DescribeInstanceTopologyPaginator,\n DescribeInstanceTypeOfferingsPaginator,\n DescribeInstanceTypesPaginator,\n DescribeInstancesPaginator,\n DescribeInternetGatewaysPaginator,\n DescribeIpamPoolsPaginator,\n DescribeIpamResourceDiscoveriesPaginator,\n DescribeIpamResourceDiscoveryAssociationsPaginator,\n DescribeIpamScopesPaginator,\n DescribeIpamsPaginator,\n DescribeIpv6PoolsPaginator,\n DescribeLaunchTemplateVersionsPaginator,\n DescribeLaunchTemplatesPaginator,\n DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsPaginator,\n DescribeLocalGatewayRouteTableVpcAssociationsPaginator,\n DescribeLocalGatewayRouteTablesPaginator,\n DescribeLocalGatewayVirtualInterfaceGroupsPaginator,\n DescribeLocalGatewayVirtualInterfacesPaginator,\n DescribeLocalGatewaysPaginator,\n DescribeMacHostsPaginator,\n DescribeManagedPrefixListsPaginator,\n DescribeMovingAddressesPaginator,\n DescribeNatGatewaysPaginator,\n DescribeNetworkAclsPaginator,\n DescribeNetworkInsightsAccessScopeAnalysesPaginator,\n DescribeNetworkInsightsAccessScopesPaginator,\n DescribeNetworkInsightsAnalysesPaginator,\n DescribeNetworkInsightsPathsPaginator,\n DescribeNetworkInterfacePermissionsPaginator,\n DescribeNetworkInterfacesPaginator,\n DescribePrefixListsPaginator,\n DescribePrincipalIdFormatPaginator,\n DescribePublicIpv4PoolsPaginator,\n DescribeReplaceRootVolumeTasksPaginator,\n DescribeReservedInstancesModificationsPaginator,\n DescribeReservedInstancesOfferingsPaginator,\n DescribeRouteTablesPaginator,\n DescribeScheduledInstanceAvailabilityPaginator,\n DescribeScheduledInstancesPaginator,\n DescribeSecurityGroupRulesPaginator,\n DescribeSecurityGroupsPaginator,\n DescribeSnapshotTierStatusPaginator,\n DescribeSnapshotsPaginator,\n DescribeSpotFleetInstancesPaginator,\n DescribeSpotFleetRequestsPaginator,\n DescribeSpotInstanceRequestsPaginator,\n DescribeSpotPriceHistoryPaginator,\n DescribeStaleSecurityGroupsPaginator,\n DescribeStoreImageTasksPaginator,\n DescribeSubnetsPaginator,\n DescribeTagsPaginator,\n DescribeTrafficMirrorFiltersPaginator,\n DescribeTrafficMirrorSessionsPaginator,\n DescribeTrafficMirrorTargetsPaginator,\n DescribeTransitGatewayAttachmentsPaginator,\n DescribeTransitGatewayConnectPeersPaginator,\n DescribeTransitGatewayConnectsPaginator,\n DescribeTransitGatewayMulticastDomainsPaginator,\n DescribeTransitGatewayPeeringAttachmentsPaginator,\n DescribeTransitGatewayPolicyTablesPaginator,\n DescribeTransitGatewayRouteTableAnnouncementsPaginator,\n DescribeTransitGatewayRouteTablesPaginator,\n DescribeTransitGatewayVpcAttachmentsPaginator,\n DescribeTransitGatewaysPaginator,\n DescribeTrunkInterfaceAssociationsPaginator,\n DescribeVerifiedAccessEndpointsPaginator,\n DescribeVerifiedAccessGroupsPaginator,\n DescribeVerifiedAccessInstanceLoggingConfigurationsPaginator,\n DescribeVerifiedAccessInstancesPaginator,\n DescribeVerifiedAccessTrustProvidersPaginator,\n DescribeVolumeStatusPaginator,\n DescribeVolumesPaginator,\n DescribeVolumesModificationsPaginator,\n DescribeVpcClassicLinkDnsSupportPaginator,\n DescribeVpcEndpointConnectionNotificationsPaginator,\n DescribeVpcEndpointConnectionsPaginator,\n DescribeVpcEndpointServiceConfigurationsPaginator,\n DescribeVpcEndpointServicePermissionsPaginator,\n DescribeVpcEndpointServicesPaginator,\n DescribeVpcEndpointsPaginator,\n DescribeVpcPeeringConnectionsPaginator,\n DescribeVpcsPaginator,\n GetAssociatedIpv6PoolCidrsPaginator,\n GetAwsNetworkPerformanceDataPaginator,\n GetGroupsForCapacityReservationPaginator,\n GetInstanceTypesFromInstanceRequirementsPaginator,\n GetIpamAddressHistoryPaginator,\n GetIpamDiscoveredAccountsPaginator,\n GetIpamDiscoveredResourceCidrsPaginator,\n GetIpamPoolAllocationsPaginator,\n GetIpamPoolCidrsPaginator,\n GetIpamResourceCidrsPaginator,\n GetManagedPrefixListAssociationsPaginator,\n GetManagedPrefixListEntriesPaginator,\n GetNetworkInsightsAccessScopeAnalysisFindingsPaginator,\n GetSecurityGroupsForVpcPaginator,\n GetSpotPlacementScoresPaginator,\n GetTransitGatewayAttachmentPropagationsPaginator,\n GetTransitGatewayMulticastDomainAssociationsPaginator,\n GetTransitGatewayPolicyTableAssociationsPaginator,\n GetTransitGatewayPrefixListReferencesPaginator,\n GetTransitGatewayRouteTableAssociationsPaginator,\n GetTransitGatewayRouteTablePropagationsPaginator,\n GetVpnConnectionDeviceTypesPaginator,\n ListImagesInRecycleBinPaginator,\n ListSnapshotsInRecycleBinPaginator,\n SearchLocalGatewayRoutesPaginator,\n SearchTransitGatewayMulticastGroupsPaginator,\n)\n\nclient: EC2Client = Session().client(\"ec2\")\n\n# Explicit type annotations are optional here\n# Types should be correctly discovered by mypy and IDEs\ndescribe_address_transfers_paginator: DescribeAddressTransfersPaginator = client.get_paginator(\n \"describe_address_transfers\"\n)\ndescribe_addresses_attribute_paginator: DescribeAddressesAttributePaginator = client.get_paginator(\n \"describe_addresses_attribute\"\n)\ndescribe_aws_network_performance_metric_subscriptions_paginator: (\n DescribeAwsNetworkPerformanceMetricSubscriptionsPaginator\n) = client.get_paginator(\"describe_aws_network_performance_metric_subscriptions\")\ndescribe_byoip_cidrs_paginator: DescribeByoipCidrsPaginator = client.get_paginator(\n \"describe_byoip_cidrs\"\n)\ndescribe_capacity_block_offerings_paginator: DescribeCapacityBlockOfferingsPaginator = (\n client.get_paginator(\"describe_capacity_block_offerings\")\n)\ndescribe_capacity_reservation_fleets_paginator: DescribeCapacityReservationFleetsPaginator = (\n client.get_paginator(\"describe_capacity_reservation_fleets\")\n)\ndescribe_capacity_reservations_paginator: DescribeCapacityReservationsPaginator = (\n client.get_paginator(\"describe_capacity_reservations\")\n)\ndescribe_carrier_gateways_paginator: DescribeCarrierGatewaysPaginator = client.get_paginator(\n \"describe_carrier_gateways\"\n)\ndescribe_classic_link_instances_paginator: DescribeClassicLinkInstancesPaginator = (\n client.get_paginator(\"describe_classic_link_instances\")\n)\ndescribe_client_vpn_authorization_rules_paginator: DescribeClientVpnAuthorizationRulesPaginator = (\n client.get_paginator(\"describe_client_vpn_authorization_rules\")\n)\ndescribe_client_vpn_connections_paginator: DescribeClientVpnConnectionsPaginator = (\n client.get_paginator(\"describe_client_vpn_connections\")\n)\ndescribe_client_vpn_endpoints_paginator: DescribeClientVpnEndpointsPaginator = client.get_paginator(\n \"describe_client_vpn_endpoints\"\n)\ndescribe_client_vpn_routes_paginator: DescribeClientVpnRoutesPaginator = client.get_paginator(\n \"describe_client_vpn_routes\"\n)\ndescribe_client_vpn_target_networks_paginator: DescribeClientVpnTargetNetworksPaginator = (\n client.get_paginator(\"describe_client_vpn_target_networks\")\n)\ndescribe_coip_pools_paginator: DescribeCoipPoolsPaginator = client.get_paginator(\n \"describe_coip_pools\"\n)\ndescribe_dhcp_options_paginator: DescribeDhcpOptionsPaginator = client.get_paginator(\n \"describe_dhcp_options\"\n)\ndescribe_egress_only_internet_gateways_paginator: DescribeEgressOnlyInternetGatewaysPaginator = (\n client.get_paginator(\"describe_egress_only_internet_gateways\")\n)\ndescribe_export_image_tasks_paginator: DescribeExportImageTasksPaginator = client.get_paginator(\n \"describe_export_image_tasks\"\n)\ndescribe_fast_launch_images_paginator: DescribeFastLaunchImagesPaginator = client.get_paginator(\n \"describe_fast_launch_images\"\n)\ndescribe_fast_snapshot_restores_paginator: DescribeFastSnapshotRestoresPaginator = (\n client.get_paginator(\"describe_fast_snapshot_restores\")\n)\ndescribe_fleets_paginator: DescribeFleetsPaginator = client.get_paginator(\"describe_fleets\")\ndescribe_flow_logs_paginator: DescribeFlowLogsPaginator = client.get_paginator(\"describe_flow_logs\")\ndescribe_fpga_images_paginator: DescribeFpgaImagesPaginator = client.get_paginator(\n \"describe_fpga_images\"\n)\ndescribe_host_reservation_offerings_paginator: DescribeHostReservationOfferingsPaginator = (\n client.get_paginator(\"describe_host_reservation_offerings\")\n)\ndescribe_host_reservations_paginator: DescribeHostReservationsPaginator = client.get_paginator(\n \"describe_host_reservations\"\n)\ndescribe_hosts_paginator: DescribeHostsPaginator = client.get_paginator(\"describe_hosts\")\ndescribe_iam_instance_profile_associations_paginator: (\n DescribeIamInstanceProfileAssociationsPaginator\n) = client.get_paginator(\"describe_iam_instance_profile_associations\")\ndescribe_images_paginator: DescribeImagesPaginator = client.get_paginator(\"describe_images\")\ndescribe_import_image_tasks_paginator: DescribeImportImageTasksPaginator = client.get_paginator(\n \"describe_import_image_tasks\"\n)\ndescribe_import_snapshot_tasks_paginator: DescribeImportSnapshotTasksPaginator = (\n client.get_paginator(\"describe_import_snapshot_tasks\")\n)\ndescribe_instance_connect_endpoints_paginator: DescribeInstanceConnectEndpointsPaginator = (\n client.get_paginator(\"describe_instance_connect_endpoints\")\n)\ndescribe_instance_credit_specifications_paginator: DescribeInstanceCreditSpecificationsPaginator = (\n client.get_paginator(\"describe_instance_credit_specifications\")\n)\ndescribe_instance_event_windows_paginator: DescribeInstanceEventWindowsPaginator = (\n client.get_paginator(\"describe_instance_event_windows\")\n)\ndescribe_instance_status_paginator: DescribeInstanceStatusPaginator = client.get_paginator(\n \"describe_instance_status\"\n)\ndescribe_instance_topology_paginator: DescribeInstanceTopologyPaginator = client.get_paginator(\n \"describe_instance_topology\"\n)\ndescribe_instance_type_offerings_paginator: DescribeInstanceTypeOfferingsPaginator = (\n client.get_paginator(\"describe_instance_type_offerings\")\n)\ndescribe_instance_types_paginator: DescribeInstanceTypesPaginator = client.get_paginator(\n \"describe_instance_types\"\n)\ndescribe_instances_paginator: DescribeInstancesPaginator = client.get_paginator(\n \"describe_instances\"\n)\ndescribe_internet_gateways_paginator: DescribeInternetGatewaysPaginator = client.get_paginator(\n \"describe_internet_gateways\"\n)\ndescribe_ipam_pools_paginator: DescribeIpamPoolsPaginator = client.get_paginator(\n \"describe_ipam_pools\"\n)\ndescribe_ipam_resource_discoveries_paginator: DescribeIpamResourceDiscoveriesPaginator = (\n client.get_paginator(\"describe_ipam_resource_discoveries\")\n)\ndescribe_ipam_resource_discovery_associations_paginator: (\n DescribeIpamResourceDiscoveryAssociationsPaginator\n) = client.get_paginator(\"describe_ipam_resource_discovery_associations\")\ndescribe_ipam_scopes_paginator: DescribeIpamScopesPaginator = client.get_paginator(\n \"describe_ipam_scopes\"\n)\ndescribe_ipams_paginator: DescribeIpamsPaginator = client.get_paginator(\"describe_ipams\")\ndescribe_ipv6_pools_paginator: DescribeIpv6PoolsPaginator = client.get_paginator(\n \"describe_ipv6_pools\"\n)\ndescribe_launch_template_versions_paginator: DescribeLaunchTemplateVersionsPaginator = (\n client.get_paginator(\"describe_launch_template_versions\")\n)\ndescribe_launch_templates_paginator: DescribeLaunchTemplatesPaginator = client.get_paginator(\n \"describe_launch_templates\"\n)\ndescribe_local_gateway_route_table_virtual_interface_group_associations_paginator: (\n DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsPaginator\n) = client.get_paginator(\"describe_local_gateway_route_table_virtual_interface_group_associations\")\ndescribe_local_gateway_route_table_vpc_associations_paginator: (\n DescribeLocalGatewayRouteTableVpcAssociationsPaginator\n) = client.get_paginator(\"describe_local_gateway_route_table_vpc_associations\")\ndescribe_local_gateway_route_tables_paginator: DescribeLocalGatewayRouteTablesPaginator = (\n client.get_paginator(\"describe_local_gateway_route_tables\")\n)\ndescribe_local_gateway_virtual_interface_groups_paginator: (\n DescribeLocalGatewayVirtualInterfaceGroupsPaginator\n) = client.get_paginator(\"describe_local_gateway_virtual_interface_groups\")\ndescribe_local_gateway_virtual_interfaces_paginator: (\n DescribeLocalGatewayVirtualInterfacesPaginator\n) = client.get_paginator(\"describe_local_gateway_virtual_interfaces\")\ndescribe_local_gateways_paginator: DescribeLocalGatewaysPaginator = client.get_paginator(\n \"describe_local_gateways\"\n)\ndescribe_mac_hosts_paginator: DescribeMacHostsPaginator = client.get_paginator(\"describe_mac_hosts\")\ndescribe_managed_prefix_lists_paginator: DescribeManagedPrefixListsPaginator = client.get_paginator(\n \"describe_managed_prefix_lists\"\n)\ndescribe_moving_addresses_paginator: DescribeMovingAddressesPaginator = client.get_paginator(\n \"describe_moving_addresses\"\n)\ndescribe_nat_gateways_paginator: DescribeNatGatewaysPaginator = client.get_paginator(\n \"describe_nat_gateways\"\n)\ndescribe_network_acls_paginator: DescribeNetworkAclsPaginator = client.get_paginator(\n \"describe_network_acls\"\n)\ndescribe_network_insights_access_scope_analyses_paginator: (\n DescribeNetworkInsightsAccessScopeAnalysesPaginator\n) = client.get_paginator(\"describe_network_insights_access_scope_analyses\")\ndescribe_network_insights_access_scopes_paginator: DescribeNetworkInsightsAccessScopesPaginator = (\n client.get_paginator(\"describe_network_insights_access_scopes\")\n)\ndescribe_network_insights_analyses_paginator: DescribeNetworkInsightsAnalysesPaginator = (\n client.get_paginator(\"describe_network_insights_analyses\")\n)\ndescribe_network_insights_paths_paginator: DescribeNetworkInsightsPathsPaginator = (\n client.get_paginator(\"describe_network_insights_paths\")\n)\ndescribe_network_interface_permissions_paginator: DescribeNetworkInterfacePermissionsPaginator = (\n client.get_paginator(\"describe_network_interface_permissions\")\n)\ndescribe_network_interfaces_paginator: DescribeNetworkInterfacesPaginator = client.get_paginator(\n \"describe_network_interfaces\"\n)\ndescribe_prefix_lists_paginator: DescribePrefixListsPaginator = client.get_paginator(\n \"describe_prefix_lists\"\n)\ndescribe_principal_id_format_paginator: DescribePrincipalIdFormatPaginator = client.get_paginator(\n \"describe_principal_id_format\"\n)\ndescribe_public_ipv4_pools_paginator: DescribePublicIpv4PoolsPaginator = client.get_paginator(\n \"describe_public_ipv4_pools\"\n)\ndescribe_replace_root_volume_tasks_paginator: DescribeReplaceRootVolumeTasksPaginator = (\n client.get_paginator(\"describe_replace_root_volume_tasks\")\n)\ndescribe_reserved_instances_modifications_paginator: (\n DescribeReservedInstancesModificationsPaginator\n) = client.get_paginator(\"describe_reserved_instances_modifications\")\ndescribe_reserved_instances_offerings_paginator: DescribeReservedInstancesOfferingsPaginator = (\n client.get_paginator(\"describe_reserved_instances_offerings\")\n)\ndescribe_route_tables_paginator: DescribeRouteTablesPaginator = client.get_paginator(\n \"describe_route_tables\"\n)\ndescribe_scheduled_instance_availability_paginator: (\n DescribeScheduledInstanceAvailabilityPaginator\n) = client.get_paginator(\"describe_scheduled_instance_availability\")\ndescribe_scheduled_instances_paginator: DescribeScheduledInstancesPaginator = client.get_paginator(\n \"describe_scheduled_instances\"\n)\ndescribe_security_group_rules_paginator: DescribeSecurityGroupRulesPaginator = client.get_paginator(\n \"describe_security_group_rules\"\n)\ndescribe_security_groups_paginator: DescribeSecurityGroupsPaginator = client.get_paginator(\n \"describe_security_groups\"\n)\ndescribe_snapshot_tier_status_paginator: DescribeSnapshotTierStatusPaginator = client.get_paginator(\n \"describe_snapshot_tier_status\"\n)\ndescribe_snapshots_paginator: DescribeSnapshotsPaginator = client.get_paginator(\n \"describe_snapshots\"\n)\ndescribe_spot_fleet_instances_paginator: DescribeSpotFleetInstancesPaginator = client.get_paginator(\n \"describe_spot_fleet_instances\"\n)\ndescribe_spot_fleet_requests_paginator: DescribeSpotFleetRequestsPaginator = client.get_paginator(\n \"describe_spot_fleet_requests\"\n)\ndescribe_spot_instance_requests_paginator: DescribeSpotInstanceRequestsPaginator = (\n client.get_paginator(\"describe_spot_instance_requests\")\n)\ndescribe_spot_price_history_paginator: DescribeSpotPriceHistoryPaginator = client.get_paginator(\n \"describe_spot_price_history\"\n)\ndescribe_stale_security_groups_paginator: DescribeStaleSecurityGroupsPaginator = (\n client.get_paginator(\"describe_stale_security_groups\")\n)\ndescribe_store_image_tasks_paginator: DescribeStoreImageTasksPaginator = client.get_paginator(\n \"describe_store_image_tasks\"\n)\ndescribe_subnets_paginator: DescribeSubnetsPaginator = client.get_paginator(\"describe_subnets\")\ndescribe_tags_paginator: DescribeTagsPaginator = client.get_paginator(\"describe_tags\")\ndescribe_traffic_mirror_filters_paginator: DescribeTrafficMirrorFiltersPaginator = (\n client.get_paginator(\"describe_traffic_mirror_filters\")\n)\ndescribe_traffic_mirror_sessions_paginator: DescribeTrafficMirrorSessionsPaginator = (\n client.get_paginator(\"describe_traffic_mirror_sessions\")\n)\ndescribe_traffic_mirror_targets_paginator: DescribeTrafficMirrorTargetsPaginator = (\n client.get_paginator(\"describe_traffic_mirror_targets\")\n)\ndescribe_transit_gateway_attachments_paginator: DescribeTransitGatewayAttachmentsPaginator = (\n client.get_paginator(\"describe_transit_gateway_attachments\")\n)\ndescribe_transit_gateway_connect_peers_paginator: DescribeTransitGatewayConnectPeersPaginator = (\n client.get_paginator(\"describe_transit_gateway_connect_peers\")\n)\ndescribe_transit_gateway_connects_paginator: DescribeTransitGatewayConnectsPaginator = (\n client.get_paginator(\"describe_transit_gateway_connects\")\n)\ndescribe_transit_gateway_multicast_domains_paginator: (\n DescribeTransitGatewayMulticastDomainsPaginator\n) = client.get_paginator(\"describe_transit_gateway_multicast_domains\")\ndescribe_transit_gateway_peering_attachments_paginator: (\n DescribeTransitGatewayPeeringAttachmentsPaginator\n) = client.get_paginator(\"describe_transit_gateway_peering_attachments\")\ndescribe_transit_gateway_policy_tables_paginator: DescribeTransitGatewayPolicyTablesPaginator = (\n client.get_paginator(\"describe_transit_gateway_policy_tables\")\n)\ndescribe_transit_gateway_route_table_announcements_paginator: (\n DescribeTransitGatewayRouteTableAnnouncementsPaginator\n) = client.get_paginator(\"describe_transit_gateway_route_table_announcements\")\ndescribe_transit_gateway_route_tables_paginator: DescribeTransitGatewayRouteTablesPaginator = (\n client.get_paginator(\"describe_transit_gateway_route_tables\")\n)\ndescribe_transit_gateway_vpc_attachments_paginator: (\n DescribeTransitGatewayVpcAttachmentsPaginator\n) = client.get_paginator(\"describe_transit_gateway_vpc_attachments\")\ndescribe_transit_gateways_paginator: DescribeTransitGatewaysPaginator = client.get_paginator(\n \"describe_transit_gateways\"\n)\ndescribe_trunk_interface_associations_paginator: DescribeTrunkInterfaceAssociationsPaginator = (\n client.get_paginator(\"describe_trunk_interface_associations\")\n)\ndescribe_verified_access_endpoints_paginator: DescribeVerifiedAccessEndpointsPaginator = (\n client.get_paginator(\"describe_verified_access_endpoints\")\n)\ndescribe_verified_access_groups_paginator: DescribeVerifiedAccessGroupsPaginator = (\n client.get_paginator(\"describe_verified_access_groups\")\n)\ndescribe_verified_access_instance_logging_configurations_paginator: (\n DescribeVerifiedAccessInstanceLoggingConfigurationsPaginator\n) = client.get_paginator(\"describe_verified_access_instance_logging_configurations\")\ndescribe_verified_access_instances_paginator: DescribeVerifiedAccessInstancesPaginator = (\n client.get_paginator(\"describe_verified_access_instances\")\n)\ndescribe_verified_access_trust_providers_paginator: (\n DescribeVerifiedAccessTrustProvidersPaginator\n) = client.get_paginator(\"describe_verified_access_trust_providers\")\ndescribe_volume_status_paginator: DescribeVolumeStatusPaginator = client.get_paginator(\n \"describe_volume_status\"\n)\ndescribe_volumes_paginator: DescribeVolumesPaginator = client.get_paginator(\"describe_volumes\")\ndescribe_volumes_modifications_paginator: DescribeVolumesModificationsPaginator = (\n client.get_paginator(\"describe_volumes_modifications\")\n)\ndescribe_vpc_classic_link_dns_support_paginator: DescribeVpcClassicLinkDnsSupportPaginator = (\n client.get_paginator(\"describe_vpc_classic_link_dns_support\")\n)\ndescribe_vpc_endpoint_connection_notifications_paginator: (\n DescribeVpcEndpointConnectionNotificationsPaginator\n) = client.get_paginator(\"describe_vpc_endpoint_connection_notifications\")\ndescribe_vpc_endpoint_connections_paginator: DescribeVpcEndpointConnectionsPaginator = (\n client.get_paginator(\"describe_vpc_endpoint_connections\")\n)\ndescribe_vpc_endpoint_service_configurations_paginator: (\n DescribeVpcEndpointServiceConfigurationsPaginator\n) = client.get_paginator(\"describe_vpc_endpoint_service_configurations\")\ndescribe_vpc_endpoint_service_permissions_paginator: (\n DescribeVpcEndpointServicePermissionsPaginator\n) = client.get_paginator(\"describe_vpc_endpoint_service_permissions\")\ndescribe_vpc_endpoint_services_paginator: DescribeVpcEndpointServicesPaginator = (\n client.get_paginator(\"describe_vpc_endpoint_services\")\n)\ndescribe_vpc_endpoints_paginator: DescribeVpcEndpointsPaginator = client.get_paginator(\n \"describe_vpc_endpoints\"\n)\ndescribe_vpc_peering_connections_paginator: DescribeVpcPeeringConnectionsPaginator = (\n client.get_paginator(\"describe_vpc_peering_connections\")\n)\ndescribe_vpcs_paginator: DescribeVpcsPaginator = client.get_paginator(\"describe_vpcs\")\nget_associated_ipv6_pool_cidrs_paginator: GetAssociatedIpv6PoolCidrsPaginator = (\n client.get_paginator(\"get_associated_ipv6_pool_cidrs\")\n)\nget_aws_network_performance_data_paginator: GetAwsNetworkPerformanceDataPaginator = (\n client.get_paginator(\"get_aws_network_performance_data\")\n)\nget_groups_for_capacity_reservation_paginator: GetGroupsForCapacityReservationPaginator = (\n client.get_paginator(\"get_groups_for_capacity_reservation\")\n)\nget_instance_types_from_instance_requirements_paginator: (\n GetInstanceTypesFromInstanceRequirementsPaginator\n) = client.get_paginator(\"get_instance_types_from_instance_requirements\")\nget_ipam_address_history_paginator: GetIpamAddressHistoryPaginator = client.get_paginator(\n \"get_ipam_address_history\"\n)\nget_ipam_discovered_accounts_paginator: GetIpamDiscoveredAccountsPaginator = client.get_paginator(\n \"get_ipam_discovered_accounts\"\n)\nget_ipam_discovered_resource_cidrs_paginator: GetIpamDiscoveredResourceCidrsPaginator = (\n client.get_paginator(\"get_ipam_discovered_resource_cidrs\")\n)\nget_ipam_pool_allocations_paginator: GetIpamPoolAllocationsPaginator = client.get_paginator(\n \"get_ipam_pool_allocations\"\n)\nget_ipam_pool_cidrs_paginator: GetIpamPoolCidrsPaginator = client.get_paginator(\n \"get_ipam_pool_cidrs\"\n)\nget_ipam_resource_cidrs_paginator: GetIpamResourceCidrsPaginator = client.get_paginator(\n \"get_ipam_resource_cidrs\"\n)\nget_managed_prefix_list_associations_paginator: GetManagedPrefixListAssociationsPaginator = (\n client.get_paginator(\"get_managed_prefix_list_associations\")\n)\nget_managed_prefix_list_entries_paginator: GetManagedPrefixListEntriesPaginator = (\n client.get_paginator(\"get_managed_prefix_list_entries\")\n)\nget_network_insights_access_scope_analysis_findings_paginator: (\n GetNetworkInsightsAccessScopeAnalysisFindingsPaginator\n) = client.get_paginator(\"get_network_insights_access_scope_analysis_findings\")\nget_security_groups_for_vpc_paginator: GetSecurityGroupsForVpcPaginator = client.get_paginator(\n \"get_security_groups_for_vpc\"\n)\nget_spot_placement_scores_paginator: GetSpotPlacementScoresPaginator = client.get_paginator(\n \"get_spot_placement_scores\"\n)\nget_transit_gateway_attachment_propagations_paginator: (\n GetTransitGatewayAttachmentPropagationsPaginator\n) = client.get_paginator(\"get_transit_gateway_attachment_propagations\")\nget_transit_gateway_multicast_domain_associations_paginator: (\n GetTransitGatewayMulticastDomainAssociationsPaginator\n) = client.get_paginator(\"get_transit_gateway_multicast_domain_associations\")\nget_transit_gateway_policy_table_associations_paginator: (\n GetTransitGatewayPolicyTableAssociationsPaginator\n) = client.get_paginator(\"get_transit_gateway_policy_table_associations\")\nget_transit_gateway_prefix_list_references_paginator: (\n GetTransitGatewayPrefixListReferencesPaginator\n) = client.get_paginator(\"get_transit_gateway_prefix_list_references\")\nget_transit_gateway_route_table_associations_paginator: (\n GetTransitGatewayRouteTableAssociationsPaginator\n) = client.get_paginator(\"get_transit_gateway_route_table_associations\")\nget_transit_gateway_route_table_propagations_paginator: (\n GetTransitGatewayRouteTablePropagationsPaginator\n) = client.get_paginator(\"get_transit_gateway_route_table_propagations\")\nget_vpn_connection_device_types_paginator: GetVpnConnectionDeviceTypesPaginator = (\n client.get_paginator(\"get_vpn_connection_device_types\")\n)\nlist_images_in_recycle_bin_paginator: ListImagesInRecycleBinPaginator = client.get_paginator(\n \"list_images_in_recycle_bin\"\n)\nlist_snapshots_in_recycle_bin_paginator: ListSnapshotsInRecycleBinPaginator = client.get_paginator(\n \"list_snapshots_in_recycle_bin\"\n)\nsearch_local_gateway_routes_paginator: SearchLocalGatewayRoutesPaginator = client.get_paginator(\n \"search_local_gateway_routes\"\n)\nsearch_transit_gateway_multicast_groups_paginator: SearchTransitGatewayMulticastGroupsPaginator = (\n client.get_paginator(\"search_transit_gateway_multicast_groups\")\n)\n```\n\n<a id=\"waiters-annotations\"></a>\n\n### Waiters annotations\n\n`mypy_boto3_ec2.waiter` module contains type annotations for all waiters.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_ec2 import EC2Client\nfrom mypy_boto3_ec2.waiter import (\n BundleTaskCompleteWaiter,\n ConversionTaskCancelledWaiter,\n ConversionTaskCompletedWaiter,\n ConversionTaskDeletedWaiter,\n CustomerGatewayAvailableWaiter,\n ExportTaskCancelledWaiter,\n ExportTaskCompletedWaiter,\n ImageAvailableWaiter,\n ImageExistsWaiter,\n InstanceExistsWaiter,\n InstanceRunningWaiter,\n InstanceStatusOkWaiter,\n InstanceStoppedWaiter,\n InstanceTerminatedWaiter,\n InternetGatewayExistsWaiter,\n KeyPairExistsWaiter,\n NatGatewayAvailableWaiter,\n NatGatewayDeletedWaiter,\n NetworkInterfaceAvailableWaiter,\n PasswordDataAvailableWaiter,\n SecurityGroupExistsWaiter,\n SnapshotCompletedWaiter,\n SnapshotImportedWaiter,\n SpotInstanceRequestFulfilledWaiter,\n StoreImageTaskCompleteWaiter,\n SubnetAvailableWaiter,\n SystemStatusOkWaiter,\n VolumeAvailableWaiter,\n VolumeDeletedWaiter,\n VolumeInUseWaiter,\n VpcAvailableWaiter,\n VpcExistsWaiter,\n VpcPeeringConnectionDeletedWaiter,\n VpcPeeringConnectionExistsWaiter,\n VpnConnectionAvailableWaiter,\n VpnConnectionDeletedWaiter,\n)\n\nclient: EC2Client = Session().client(\"ec2\")\n\n# Explicit type annotations are optional here\n# Types should be correctly discovered by mypy and IDEs\nbundle_task_complete_waiter: BundleTaskCompleteWaiter = client.get_waiter(\"bundle_task_complete\")\nconversion_task_cancelled_waiter: ConversionTaskCancelledWaiter = client.get_waiter(\n \"conversion_task_cancelled\"\n)\nconversion_task_completed_waiter: ConversionTaskCompletedWaiter = client.get_waiter(\n \"conversion_task_completed\"\n)\nconversion_task_deleted_waiter: ConversionTaskDeletedWaiter = client.get_waiter(\n \"conversion_task_deleted\"\n)\ncustomer_gateway_available_waiter: CustomerGatewayAvailableWaiter = client.get_waiter(\n \"customer_gateway_available\"\n)\nexport_task_cancelled_waiter: ExportTaskCancelledWaiter = client.get_waiter(\"export_task_cancelled\")\nexport_task_completed_waiter: ExportTaskCompletedWaiter = client.get_waiter(\"export_task_completed\")\nimage_available_waiter: ImageAvailableWaiter = client.get_waiter(\"image_available\")\nimage_exists_waiter: ImageExistsWaiter = client.get_waiter(\"image_exists\")\ninstance_exists_waiter: InstanceExistsWaiter = client.get_waiter(\"instance_exists\")\ninstance_running_waiter: InstanceRunningWaiter = client.get_waiter(\"instance_running\")\ninstance_status_ok_waiter: InstanceStatusOkWaiter = client.get_waiter(\"instance_status_ok\")\ninstance_stopped_waiter: InstanceStoppedWaiter = client.get_waiter(\"instance_stopped\")\ninstance_terminated_waiter: InstanceTerminatedWaiter = client.get_waiter(\"instance_terminated\")\ninternet_gateway_exists_waiter: InternetGatewayExistsWaiter = client.get_waiter(\n \"internet_gateway_exists\"\n)\nkey_pair_exists_waiter: KeyPairExistsWaiter = client.get_waiter(\"key_pair_exists\")\nnat_gateway_available_waiter: NatGatewayAvailableWaiter = client.get_waiter(\"nat_gateway_available\")\nnat_gateway_deleted_waiter: NatGatewayDeletedWaiter = client.get_waiter(\"nat_gateway_deleted\")\nnetwork_interface_available_waiter: NetworkInterfaceAvailableWaiter = client.get_waiter(\n \"network_interface_available\"\n)\npassword_data_available_waiter: PasswordDataAvailableWaiter = client.get_waiter(\n \"password_data_available\"\n)\nsecurity_group_exists_waiter: SecurityGroupExistsWaiter = client.get_waiter(\"security_group_exists\")\nsnapshot_completed_waiter: SnapshotCompletedWaiter = client.get_waiter(\"snapshot_completed\")\nsnapshot_imported_waiter: SnapshotImportedWaiter = client.get_waiter(\"snapshot_imported\")\nspot_instance_request_fulfilled_waiter: SpotInstanceRequestFulfilledWaiter = client.get_waiter(\n \"spot_instance_request_fulfilled\"\n)\nstore_image_task_complete_waiter: StoreImageTaskCompleteWaiter = client.get_waiter(\n \"store_image_task_complete\"\n)\nsubnet_available_waiter: SubnetAvailableWaiter = client.get_waiter(\"subnet_available\")\nsystem_status_ok_waiter: SystemStatusOkWaiter = client.get_waiter(\"system_status_ok\")\nvolume_available_waiter: VolumeAvailableWaiter = client.get_waiter(\"volume_available\")\nvolume_deleted_waiter: VolumeDeletedWaiter = client.get_waiter(\"volume_deleted\")\nvolume_in_use_waiter: VolumeInUseWaiter = client.get_waiter(\"volume_in_use\")\nvpc_available_waiter: VpcAvailableWaiter = client.get_waiter(\"vpc_available\")\nvpc_exists_waiter: VpcExistsWaiter = client.get_waiter(\"vpc_exists\")\nvpc_peering_connection_deleted_waiter: VpcPeeringConnectionDeletedWaiter = client.get_waiter(\n \"vpc_peering_connection_deleted\"\n)\nvpc_peering_connection_exists_waiter: VpcPeeringConnectionExistsWaiter = client.get_waiter(\n \"vpc_peering_connection_exists\"\n)\nvpn_connection_available_waiter: VpnConnectionAvailableWaiter = client.get_waiter(\n \"vpn_connection_available\"\n)\nvpn_connection_deleted_waiter: VpnConnectionDeletedWaiter = client.get_waiter(\n \"vpn_connection_deleted\"\n)\n```\n\n<a id=\"service-resource-annotations\"></a>\n\n### Service Resource annotations\n\n`EC2ServiceResource` provides annotations for `boto3.resource(\"ec2\")`.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_ec2 import EC2ServiceResource\n\nresource: EC2ServiceResource = Session().resource(\"ec2\")\n\n# now resource usage is checked by mypy and IDE should provide code completion\n```\n\n<a id=\"other-resources-annotations\"></a>\n\n### Other resources annotations\n\n`mypy_boto3_ec2.service_resource` module contains type annotations for all\nresources.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_ec2 import EC2ServiceResource\nfrom mypy_boto3_ec2.service_resource import (\n ClassicAddress,\n DhcpOptions,\n Image,\n Instance,\n InternetGateway,\n KeyPair,\n KeyPairInfo,\n NetworkAcl,\n NetworkInterface,\n NetworkInterfaceAssociation,\n PlacementGroup,\n Route,\n RouteTable,\n RouteTableAssociation,\n SecurityGroup,\n Snapshot,\n Subnet,\n Tag,\n Volume,\n Vpc,\n VpcPeeringConnection,\n VpcAddress,\n)\n\nresource: EC2ServiceResource = Session().resource(\"ec2\")\n\n# Explicit type annotations are optional here\n# Type should be correctly discovered by mypy and IDEs\nmy_classic_address: ClassicAddress = resource.ClassicAddress(...)\nmy_dhcp_options: DhcpOptions = resource.DhcpOptions(...)\nmy_image: Image = resource.Image(...)\nmy_instance: Instance = resource.Instance(...)\nmy_internet_gateway: InternetGateway = resource.InternetGateway(...)\nmy_key_pair: KeyPair = resource.KeyPair(...)\nmy_key_pair_info: KeyPairInfo = resource.KeyPairInfo(...)\nmy_network_acl: NetworkAcl = resource.NetworkAcl(...)\nmy_network_interface: NetworkInterface = resource.NetworkInterface(...)\nmy_network_interface_association: NetworkInterfaceAssociation = (\n resource.NetworkInterfaceAssociation(...)\n)\nmy_placement_group: PlacementGroup = resource.PlacementGroup(...)\nmy_route: Route = resource.Route(...)\nmy_route_table: RouteTable = resource.RouteTable(...)\nmy_route_table_association: RouteTableAssociation = resource.RouteTableAssociation(...)\nmy_security_group: SecurityGroup = resource.SecurityGroup(...)\nmy_snapshot: Snapshot = resource.Snapshot(...)\nmy_subnet: Subnet = resource.Subnet(...)\nmy_tag: Tag = resource.Tag(...)\nmy_volume: Volume = resource.Volume(...)\nmy_vpc: Vpc = resource.Vpc(...)\nmy_vpc_peering_connection: VpcPeeringConnection = resource.VpcPeeringConnection(...)\nmy_vpc_address: VpcAddress = resource.VpcAddress(...)\n```\n\n<a id=\"collections-annotations\"></a>\n\n### Collections annotations\n\n`mypy_boto3_ec2.service_resource` module contains type annotations for all\n`EC2ServiceResource` collections.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_ec2 import EC2ServiceResource\nfrom mypy_boto3_ec2.service_resource import (\n ServiceResourceClassicAddressesCollection,\n ServiceResourceDhcpOptionsSetsCollection,\n ServiceResourceImagesCollection,\n ServiceResourceInstancesCollection,\n ServiceResourceInternetGatewaysCollection,\n ServiceResourceKeyPairsCollection,\n ServiceResourceNetworkAclsCollection,\n ServiceResourceNetworkInterfacesCollection,\n ServiceResourcePlacementGroupsCollection,\n ServiceResourceRouteTablesCollection,\n ServiceResourceSecurityGroupsCollection,\n ServiceResourceSnapshotsCollection,\n ServiceResourceSubnetsCollection,\n ServiceResourceVolumesCollection,\n ServiceResourceVpcAddressesCollection,\n ServiceResourceVpcPeeringConnectionsCollection,\n ServiceResourceVpcsCollection,\n)\n\nresource: EC2ServiceResource = Session().resource(\"ec2\")\n\n# Explicit type annotations are optional here\n# Type should be correctly discovered by mypy and IDEs\nclassic_addresses: ec2_resources.ServiceResourceClassicAddressesCollection = (\n resource.classic_addresses\n)\ndhcp_options_sets: ec2_resources.ServiceResourceDhcpOptionsSetsCollection = (\n resource.dhcp_options_sets\n)\nimages: ec2_resources.ServiceResourceImagesCollection = resource.images\ninstances: ec2_resources.ServiceResourceInstancesCollection = resource.instances\ninternet_gateways: ec2_resources.ServiceResourceInternetGatewaysCollection = (\n resource.internet_gateways\n)\nkey_pairs: ec2_resources.ServiceResourceKeyPairsCollection = resource.key_pairs\nnetwork_acls: ec2_resources.ServiceResourceNetworkAclsCollection = resource.network_acls\nnetwork_interfaces: ec2_resources.ServiceResourceNetworkInterfacesCollection = (\n resource.network_interfaces\n)\nplacement_groups: ec2_resources.ServiceResourcePlacementGroupsCollection = resource.placement_groups\nroute_tables: ec2_resources.ServiceResourceRouteTablesCollection = resource.route_tables\nsecurity_groups: ec2_resources.ServiceResourceSecurityGroupsCollection = resource.security_groups\nsnapshots: ec2_resources.ServiceResourceSnapshotsCollection = resource.snapshots\nsubnets: ec2_resources.ServiceResourceSubnetsCollection = resource.subnets\nvolumes: ec2_resources.ServiceResourceVolumesCollection = resource.volumes\nvpc_addresses: ec2_resources.ServiceResourceVpcAddressesCollection = resource.vpc_addresses\nvpc_peering_connections: ec2_resources.ServiceResourceVpcPeeringConnectionsCollection = (\n resource.vpc_peering_connections\n)\nvpcs: ec2_resources.ServiceResourceVpcsCollection = resource.vpcs\n```\n\n<a id=\"literals\"></a>\n\n### Literals\n\n`mypy_boto3_ec2.literals` module contains literals extracted from shapes that\ncan be used in user code for type checking.\n\nFull list of `EC2` Literals can be found in\n[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ec2/literals/).\n\n```python\nfrom mypy_boto3_ec2.literals import AcceleratorManufacturerType\n\n\ndef check_value(value: AcceleratorManufacturerType) -> bool: ...\n```\n\n<a id=\"type-definitions\"></a>\n\n### Type definitions\n\n`mypy_boto3_ec2.type_defs` module contains structures and shapes assembled to\ntyped dictionaries and unions for additional type checking.\n\nFull list of `EC2` TypeDefs can be found in\n[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ec2/type_defs/).\n\n```python\nfrom mypy_boto3_ec2.type_defs import AcceleratorCountRequestTypeDef\n\n\ndef get_value() -> AcceleratorCountRequestTypeDef:\n return {...}\n```\n\n<a id=\"how-it-works\"></a>\n\n## How it works\n\nFully automated\n[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully\ngenerates type annotations for each service, patiently waiting for `boto3`\nupdates. It delivers drop-in type annotations for you and makes sure that:\n\n- All available `boto3` services are covered.\n- Each public class and method of every `boto3` service gets valid type\n annotations extracted from `botocore` schemas.\n- Type annotations include up-to-date documentation.\n- Link to documentation is provided for every method.\n- Code is processed by [black](https://github.com/psf/black) and\n [isort](https://github.com/PyCQA/isort) for readability.\n\n<a id=\"what's-new\"></a>\n\n## What's new\n\n<a id=\"implemented-features\"></a>\n\n### Implemented features\n\n- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`\n libraries\n- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`\n compatibility\n- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type\n annotations for each service\n- Generated `TypeDefs` for each service\n- Generated `Literals` for each service\n- Auto discovery of types for `boto3.client` and `boto3.resource` calls\n- Auto discovery of types for `session.client` and `session.resource` calls\n- Auto discovery of types for `client.get_waiter` and `client.get_paginator`\n calls\n- Auto discovery of types for `ServiceResource` and `Resource` collections\n- Auto discovery of types for `aiobotocore.Session.create_client` calls\n\n<a id=\"latest-changes\"></a>\n\n### Latest changes\n\nBuilder changelog can be found in\n[Releases](https://github.com/youtype/mypy_boto3_builder/releases).\n\n<a id=\"versioning\"></a>\n\n## Versioning\n\n`mypy-boto3-ec2` version is the same as related `boto3` version and follows\n[PEP 440](https://www.python.org/dev/peps/pep-0440/) format.\n\n<a id=\"thank-you\"></a>\n\n## Thank you\n\n- [Allie Fitter](https://github.com/alliefitter) for\n [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),\n this package is based on top of his work\n- [black](https://github.com/psf/black) developers for an awesome formatting\n tool\n- [Timothy Edmund Crosley](https://github.com/timothycrosley) for\n [isort](https://github.com/PyCQA/isort) and how flexible it is\n- [mypy](https://github.com/python/mypy) developers for doing all dirty work\n for us\n- [pyright](https://github.com/microsoft/pyright) team for the new era of typed\n Python\n\n<a id=\"documentation\"></a>\n\n## Documentation\n\nAll services type annotations can be found in\n[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ec2/)\n\n<a id=\"support-and-contributing\"></a>\n\n## Support and contributing\n\nThis package is auto-generated. Please reports any bugs or request new features\nin [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)\nrepository.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Type annotations for boto3.EC2 1.34.96 service generated with mypy-boto3-builder 7.24.0",
"version": "1.34.96",
"project_urls": {
"Documentation": "https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ec2/",
"Homepage": "https://github.com/youtype/mypy_boto3_builder",
"Source": "https://github.com/youtype/mypy_boto3_builder",
"Tracker": "https://github.com/youtype/mypy_boto3_builder/issues"
},
"split_keywords": [
"boto3",
"ec2",
"type-annotations",
"botocore",
"mypy",
"typeshed",
"autocomplete"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d185dc52ffe9c4e9fa7a7e482efc8d56a03a29def4a4b6c9ad736695367fdb0a",
"md5": "05cecfa3701be493d1e72da9586b6842",
"sha256": "e9bbed9c946d9e5f7ae157a2b21c7d564b0a9cde7d272c27bc4824ac1f99920f"
},
"downloads": -1,
"filename": "mypy_boto3_ec2-1.34.96-py3-none-any.whl",
"has_sig": false,
"md5_digest": "05cecfa3701be493d1e72da9586b6842",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 399531,
"upload_time": "2024-05-01T19:21:17",
"upload_time_iso_8601": "2024-05-01T19:21:17.710341Z",
"url": "https://files.pythonhosted.org/packages/d1/85/dc52ffe9c4e9fa7a7e482efc8d56a03a29def4a4b6c9ad736695367fdb0a/mypy_boto3_ec2-1.34.96-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "431970abe24616921b2554cf22de4d8dc964e7f59f0ed8706b1d300483752cbe",
"md5": "21aa30573d9c79553c56b0e35424b336",
"sha256": "094991853560d678d2b8ab3e1cd27bbb6e780456febddb5f6f2e7281a9b6ce17"
},
"downloads": -1,
"filename": "mypy_boto3_ec2-1.34.96.tar.gz",
"has_sig": false,
"md5_digest": "21aa30573d9c79553c56b0e35424b336",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 406936,
"upload_time": "2024-05-01T19:21:41",
"upload_time_iso_8601": "2024-05-01T19:21:41.412017Z",
"url": "https://files.pythonhosted.org/packages/43/19/70abe24616921b2554cf22de4d8dc964e7f59f0ed8706b1d300483752cbe/mypy_boto3_ec2-1.34.96.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-01 19:21:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "youtype",
"github_project": "mypy_boto3_builder",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mypy-boto3-ec2"
}
JSON
