# mypy-boto3-service-quotas
[![PyPI - mypy-boto3-service-quotas](https://img.shields.io/pypi/v/mypy-boto3-service-quotas.svg?color=blue)](https://pypi.org/project/mypy-boto3-service-quotas)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-service-quotas.svg?color=blue)](https://pypi.org/project/mypy-boto3-service-quotas)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
Type annotations for
[boto3.ServiceQuotas 1.14.47](https://boto3.amazonaws.com/v1/documentation/api/1.14.47/reference/services/service-quotas.html#ServiceQuotas) service
compatible with [mypy](https://github.com/python/mypy), [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/) and other tools.
Generated by [mypy-boto3-buider 2.2.0](https://github.com/vemel/mypy_boto3_builder).
More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page.
## How to install
Make sure you have [mypy](https://github.com/python/mypy) installed and activated in your IDE.
Install `boto3-stubs` for `ServiceQuotas` service.
```bash
python -m pip install boto3-stubs[service-quotas]
```
## How to use
### Client annotations
`ServiceQuotasClient` provides annotations for `boto3.client("service-quotas")`.
```python
import boto3
from mypy_boto3_service_quotas import ServiceQuotasClient
from mypy_boto3_service_quotas.paginator import (
ListAWSDefaultServiceQuotasPaginator,
ListRequestedServiceQuotaChangeHistoryByQuotaPaginator,
ListRequestedServiceQuotaChangeHistoryPaginator,
ListServiceQuotaIncreaseRequestsInTemplatePaginator,
ListServiceQuotasPaginator,
ListServicesPaginator,
)
from mypy_boto3_service_quotas.type_defs import ErrorReasonTypeDef, ...
client: ServiceQuotasClient = boto3.client("service-quotas")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: ServiceQuotasClient = session.client("service-quotas")
```
### Paginators annotations
`mypy_boto3_service_quotas.paginator` module contains type annotations for all paginators.
```python
client: ServiceQuotasClient = boto3.client("service-quotas")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_aws_default_service_quotas_paginator: ListAWSDefaultServiceQuotasPaginator = client.get_paginator("list_aws_default_service_quotas")
list_requested_service_quota_change_history_paginator: ListRequestedServiceQuotaChangeHistoryPaginator = client.get_paginator("list_requested_service_quota_change_history")
list_requested_service_quota_change_history_by_quota_paginator: ListRequestedServiceQuotaChangeHistoryByQuotaPaginator = client.get_paginator("list_requested_service_quota_change_history_by_quota")
list_service_quota_increase_requests_in_template_paginator: ListServiceQuotaIncreaseRequestsInTemplatePaginator = client.get_paginator("list_service_quota_increase_requests_in_template")
list_service_quotas_paginator: ListServiceQuotasPaginator = client.get_paginator("list_service_quotas")
list_services_paginator: ListServicesPaginator = client.get_paginator("list_services")
```
### Typed dictionations
`mypy_boto3_service_quotas.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
def get_structure() -> ErrorReasonTypeDef:
return {
...
}
```
## Dynamic type annotations
`mypy_boto3` command generates `boto3.client/resource` type annotations for
`mypy_boto3_service_quotas` and other installed services.
```bash
# Run this command after you add or remove service packages
python -m mypy_boto3
```
Generated type annotations provide overloads for `boto3.client` and `boto3.resource`,
`boto3.Session.client` and `boto3.Session.resource` functions,
so explicit type annotations are not needed.
- `mypy` supports function overloads as expected
- `PyCharm` also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installed
- `VSCode` does not currently support function overloads, use explicit type annotations
```python
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("service-quotas")
session_client = boto3.Session().client("service-quotas")
```