mypy-boto3-iot

Name	mypy-boto3-iot JSON
Version	1.35.33 JSON
	download
home_page	https://github.com/youtype/mypy_boto3_builder
Summary	Type annotations for boto3.IoT 1.35.33 service generated with mypy-boto3-builder 8.1.2
upload_time	2024-10-03 19:26:07
maintainer	None
docs_url	None
author	Vlad Emelianov
requires_python	>=3.8
license	MIT License
keywords	boto3 iot type-annotations botocore mypy typeshed autocomplete
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <a id="mypy-boto3-iot"></a>

# mypy-boto3-iot

[![PyPI - mypy-boto3-iot](https://img.shields.io/pypi/v/mypy-boto3-iot.svg?color=blue)](https://pypi.org/project/mypy-boto3-iot)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-iot.svg?color=blue)](https://pypi.org/project/mypy-boto3-iot)
[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iot/)
[![PyPI - Downloads](https://static.pepy.tech/badge/mypy-boto3-iot)](https://pepy.tech/project/mypy-boto3-iot)

![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)

Type annotations for
[boto3.IoT 1.35.33](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/iot.html#IoT)
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 8.1.2](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-iot docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iot/).

See how it helps to find and fix potential bugs:

![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)

- [mypy-boto3-iot](#mypy-boto3-iot)
  - [How to install](#how-to-install)
    - [VSCode extension](#vscode-extension)
    - [From PyPI with pip](#from-pypi-with-pip)
  - [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)
    - [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 `IoT`.

<a id="from-pypi-with-pip"></a>

### From PyPI with pip

Install `boto3-stubs` for `IoT` service.

```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[iot]'


# 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[iot]'


# standalone installation
python -m pip install mypy-boto3-iot
```

<a id="how-to-uninstall"></a>

## How to uninstall

```bash
python -m pip uninstall -y mypy-boto3-iot
```

<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[iot]` in your environment:

```bash
python -m pip install 'boto3-stubs[iot]'
```

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[iot]` in your environment:

```bash
python -m pip install 'boto3-stubs-lite[iot]'`
```

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[iot]'
```

- 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[iot]` with services you use in your environment:

```bash
python -m pip install 'boto3-stubs[iot]'
```

- 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[iot]` in your environment:

```bash
python -m pip install 'boto3-stubs[iot]'
```

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[iot]` in your environment:

```bash
python -m pip install 'boto3-stubs[iot]'
```

Optionally, you can install `boto3-stubs` to `typings` directory.

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

`IoTClient` provides annotations for `boto3.client("iot")`.

```python
from boto3.session import Session

from mypy_boto3_iot import IoTClient

client: IoTClient = Session().client("iot")

# now client usage is checked by mypy and IDE should provide code completion
```

<a id="paginators-annotations"></a>

### Paginators annotations

`mypy_boto3_iot.paginator` module contains type annotations for all paginators.

```python
from boto3.session import Session

from mypy_boto3_iot import IoTClient
from mypy_boto3_iot.paginator import (
    GetBehaviorModelTrainingSummariesPaginator,
    ListActiveViolationsPaginator,
    ListAttachedPoliciesPaginator,
    ListAuditFindingsPaginator,
    ListAuditMitigationActionsExecutionsPaginator,
    ListAuditMitigationActionsTasksPaginator,
    ListAuditSuppressionsPaginator,
    ListAuditTasksPaginator,
    ListAuthorizersPaginator,
    ListBillingGroupsPaginator,
    ListCACertificatesPaginator,
    ListCertificatesPaginator,
    ListCertificatesByCAPaginator,
    ListCustomMetricsPaginator,
    ListDetectMitigationActionsExecutionsPaginator,
    ListDetectMitigationActionsTasksPaginator,
    ListDimensionsPaginator,
    ListDomainConfigurationsPaginator,
    ListFleetMetricsPaginator,
    ListIndicesPaginator,
    ListJobExecutionsForJobPaginator,
    ListJobExecutionsForThingPaginator,
    ListJobTemplatesPaginator,
    ListJobsPaginator,
    ListManagedJobTemplatesPaginator,
    ListMetricValuesPaginator,
    ListMitigationActionsPaginator,
    ListOTAUpdatesPaginator,
    ListOutgoingCertificatesPaginator,
    ListPackageVersionsPaginator,
    ListPackagesPaginator,
    ListPoliciesPaginator,
    ListPolicyPrincipalsPaginator,
    ListPrincipalPoliciesPaginator,
    ListPrincipalThingsPaginator,
    ListProvisioningTemplateVersionsPaginator,
    ListProvisioningTemplatesPaginator,
    ListRelatedResourcesForAuditFindingPaginator,
    ListRoleAliasesPaginator,
    ListSbomValidationResultsPaginator,
    ListScheduledAuditsPaginator,
    ListSecurityProfilesPaginator,
    ListSecurityProfilesForTargetPaginator,
    ListStreamsPaginator,
    ListTagsForResourcePaginator,
    ListTargetsForPolicyPaginator,
    ListTargetsForSecurityProfilePaginator,
    ListThingGroupsPaginator,
    ListThingGroupsForThingPaginator,
    ListThingPrincipalsPaginator,
    ListThingRegistrationTaskReportsPaginator,
    ListThingRegistrationTasksPaginator,
    ListThingTypesPaginator,
    ListThingsPaginator,
    ListThingsInBillingGroupPaginator,
    ListThingsInThingGroupPaginator,
    ListTopicRuleDestinationsPaginator,
    ListTopicRulesPaginator,
    ListV2LoggingLevelsPaginator,
    ListViolationEventsPaginator,
)

client: IoTClient = Session().client("iot")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
get_behavior_model_training_summaries_paginator: GetBehaviorModelTrainingSummariesPaginator = (
    client.get_paginator("get_behavior_model_training_summaries")
)
list_active_violations_paginator: ListActiveViolationsPaginator = client.get_paginator(
    "list_active_violations"
)
list_attached_policies_paginator: ListAttachedPoliciesPaginator = client.get_paginator(
    "list_attached_policies"
)
list_audit_findings_paginator: ListAuditFindingsPaginator = client.get_paginator(
    "list_audit_findings"
)
list_audit_mitigation_actions_executions_paginator: ListAuditMitigationActionsExecutionsPaginator = client.get_paginator(
    "list_audit_mitigation_actions_executions"
)
list_audit_mitigation_actions_tasks_paginator: ListAuditMitigationActionsTasksPaginator = (
    client.get_paginator("list_audit_mitigation_actions_tasks")
)
list_audit_suppressions_paginator: ListAuditSuppressionsPaginator = client.get_paginator(
    "list_audit_suppressions"
)
list_audit_tasks_paginator: ListAuditTasksPaginator = client.get_paginator("list_audit_tasks")
list_authorizers_paginator: ListAuthorizersPaginator = client.get_paginator("list_authorizers")
list_billing_groups_paginator: ListBillingGroupsPaginator = client.get_paginator(
    "list_billing_groups"
)
list_ca_certificates_paginator: ListCACertificatesPaginator = client.get_paginator(
    "list_ca_certificates"
)
list_certificates_paginator: ListCertificatesPaginator = client.get_paginator("list_certificates")
list_certificates_by_ca_paginator: ListCertificatesByCAPaginator = client.get_paginator(
    "list_certificates_by_ca"
)
list_custom_metrics_paginator: ListCustomMetricsPaginator = client.get_paginator(
    "list_custom_metrics"
)
list_detect_mitigation_actions_executions_paginator: ListDetectMitigationActionsExecutionsPaginator = client.get_paginator(
    "list_detect_mitigation_actions_executions"
)
list_detect_mitigation_actions_tasks_paginator: ListDetectMitigationActionsTasksPaginator = (
    client.get_paginator("list_detect_mitigation_actions_tasks")
)
list_dimensions_paginator: ListDimensionsPaginator = client.get_paginator("list_dimensions")
list_domain_configurations_paginator: ListDomainConfigurationsPaginator = client.get_paginator(
    "list_domain_configurations"
)
list_fleet_metrics_paginator: ListFleetMetricsPaginator = client.get_paginator("list_fleet_metrics")
list_indices_paginator: ListIndicesPaginator = client.get_paginator("list_indices")
list_job_executions_for_job_paginator: ListJobExecutionsForJobPaginator = client.get_paginator(
    "list_job_executions_for_job"
)
list_job_executions_for_thing_paginator: ListJobExecutionsForThingPaginator = client.get_paginator(
    "list_job_executions_for_thing"
)
list_job_templates_paginator: ListJobTemplatesPaginator = client.get_paginator("list_job_templates")
list_jobs_paginator: ListJobsPaginator = client.get_paginator("list_jobs")
list_managed_job_templates_paginator: ListManagedJobTemplatesPaginator = client.get_paginator(
    "list_managed_job_templates"
)
list_metric_values_paginator: ListMetricValuesPaginator = client.get_paginator("list_metric_values")
list_mitigation_actions_paginator: ListMitigationActionsPaginator = client.get_paginator(
    "list_mitigation_actions"
)
list_ota_updates_paginator: ListOTAUpdatesPaginator = client.get_paginator("list_ota_updates")
list_outgoing_certificates_paginator: ListOutgoingCertificatesPaginator = client.get_paginator(
    "list_outgoing_certificates"
)
list_package_versions_paginator: ListPackageVersionsPaginator = client.get_paginator(
    "list_package_versions"
)
list_packages_paginator: ListPackagesPaginator = client.get_paginator("list_packages")
list_policies_paginator: ListPoliciesPaginator = client.get_paginator("list_policies")
list_policy_principals_paginator: ListPolicyPrincipalsPaginator = client.get_paginator(
    "list_policy_principals"
)
list_principal_policies_paginator: ListPrincipalPoliciesPaginator = client.get_paginator(
    "list_principal_policies"
)
list_principal_things_paginator: ListPrincipalThingsPaginator = client.get_paginator(
    "list_principal_things"
)
list_provisioning_template_versions_paginator: ListProvisioningTemplateVersionsPaginator = (
    client.get_paginator("list_provisioning_template_versions")
)
list_provisioning_templates_paginator: ListProvisioningTemplatesPaginator = client.get_paginator(
    "list_provisioning_templates"
)
list_related_resources_for_audit_finding_paginator: ListRelatedResourcesForAuditFindingPaginator = (
    client.get_paginator("list_related_resources_for_audit_finding")
)
list_role_aliases_paginator: ListRoleAliasesPaginator = client.get_paginator("list_role_aliases")
list_sbom_validation_results_paginator: ListSbomValidationResultsPaginator = client.get_paginator(
    "list_sbom_validation_results"
)
list_scheduled_audits_paginator: ListScheduledAuditsPaginator = client.get_paginator(
    "list_scheduled_audits"
)
list_security_profiles_paginator: ListSecurityProfilesPaginator = client.get_paginator(
    "list_security_profiles"
)
list_security_profiles_for_target_paginator: ListSecurityProfilesForTargetPaginator = (
    client.get_paginator("list_security_profiles_for_target")
)
list_streams_paginator: ListStreamsPaginator = client.get_paginator("list_streams")
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator(
    "list_tags_for_resource"
)
list_targets_for_policy_paginator: ListTargetsForPolicyPaginator = client.get_paginator(
    "list_targets_for_policy"
)
list_targets_for_security_profile_paginator: ListTargetsForSecurityProfilePaginator = (
    client.get_paginator("list_targets_for_security_profile")
)
list_thing_groups_paginator: ListThingGroupsPaginator = client.get_paginator("list_thing_groups")
list_thing_groups_for_thing_paginator: ListThingGroupsForThingPaginator = client.get_paginator(
    "list_thing_groups_for_thing"
)
list_thing_principals_paginator: ListThingPrincipalsPaginator = client.get_paginator(
    "list_thing_principals"
)
list_thing_registration_task_reports_paginator: ListThingRegistrationTaskReportsPaginator = (
    client.get_paginator("list_thing_registration_task_reports")
)
list_thing_registration_tasks_paginator: ListThingRegistrationTasksPaginator = client.get_paginator(
    "list_thing_registration_tasks"
)
list_thing_types_paginator: ListThingTypesPaginator = client.get_paginator("list_thing_types")
list_things_paginator: ListThingsPaginator = client.get_paginator("list_things")
list_things_in_billing_group_paginator: ListThingsInBillingGroupPaginator = client.get_paginator(
    "list_things_in_billing_group"
)
list_things_in_thing_group_paginator: ListThingsInThingGroupPaginator = client.get_paginator(
    "list_things_in_thing_group"
)
list_topic_rule_destinations_paginator: ListTopicRuleDestinationsPaginator = client.get_paginator(
    "list_topic_rule_destinations"
)
list_topic_rules_paginator: ListTopicRulesPaginator = client.get_paginator("list_topic_rules")
list_v2_logging_levels_paginator: ListV2LoggingLevelsPaginator = client.get_paginator(
    "list_v2_logging_levels"
)
list_violation_events_paginator: ListViolationEventsPaginator = client.get_paginator(
    "list_violation_events"
)
```

<a id="literals"></a>

### Literals

`mypy_boto3_iot.literals` module contains literals extracted from shapes that
can be used in user code for type checking.

Full list of `IoT` Literals can be found in
[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iot/literals/).

```python
from mypy_boto3_iot.literals import AbortActionType


def check_value(value: AbortActionType) -> bool: ...
```

<a id="type-definitions"></a>

### Type definitions

`mypy_boto3_iot.type_defs` module contains structures and shapes assembled to
typed dictionaries and unions for additional type checking.

Full list of `IoT` TypeDefs can be found in
[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iot/type_defs/).

```python
from mypy_boto3_iot.type_defs import AbortCriteriaTypeDef


def get_value() -> AbortCriteriaTypeDef:
    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 [ruff](https://docs.astral.sh/ruff/) 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-iot` 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_iot/)

<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-iot",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "boto3 iot type-annotations botocore mypy typeshed autocomplete",
    "author": "Vlad Emelianov",
    "author_email": "vlad.emelianov.nz@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/86/62/b7d702f540dfa347bd22d2ced72dede6c4ede38d44cbd8c0afef0a610e44/mypy_boto3_iot-1.35.33.tar.gz",
    "platform": null,
    "description": "<a id=\"mypy-boto3-iot\"></a>\n\n# mypy-boto3-iot\n\n[![PyPI - mypy-boto3-iot](https://img.shields.io/pypi/v/mypy-boto3-iot.svg?color=blue)](https://pypi.org/project/mypy-boto3-iot)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-iot.svg?color=blue)](https://pypi.org/project/mypy-boto3-iot)\n[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iot/)\n[![PyPI - Downloads](https://static.pepy.tech/badge/mypy-boto3-iot)](https://pepy.tech/project/mypy-boto3-iot)\n\n![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)\n\nType annotations for\n[boto3.IoT 1.35.33](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/iot.html#IoT)\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 8.1.2](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-iot docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iot/).\n\nSee how it helps to find and fix potential bugs:\n\n![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)\n\n- [mypy-boto3-iot](#mypy-boto3-iot)\n  - [How to install](#how-to-install)\n    - [VSCode extension](#vscode-extension)\n    - [From PyPI with pip](#from-pypi-with-pip)\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    - [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 `IoT`.\n\n<a id=\"from-pypi-with-pip\"></a>\n\n### From PyPI with pip\n\nInstall `boto3-stubs` for `IoT` service.\n\n```bash\n# install with boto3 type annotations\npython -m pip install 'boto3-stubs[iot]'\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[iot]'\n\n\n# standalone installation\npython -m pip install mypy-boto3-iot\n```\n\n<a id=\"how-to-uninstall\"></a>\n\n## How to uninstall\n\n```bash\npython -m pip uninstall -y mypy-boto3-iot\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[iot]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[iot]'\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[iot]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs-lite[iot]'`\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[iot]'\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[iot]` with services you use in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[iot]'\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[iot]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[iot]'\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[iot]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[iot]'\n```\n\nOptionally, you can install `boto3-stubs` to `typings` directory.\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`IoTClient` provides annotations for `boto3.client(\"iot\")`.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_iot import IoTClient\n\nclient: IoTClient = Session().client(\"iot\")\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_iot.paginator` module contains type annotations for all paginators.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_iot import IoTClient\nfrom mypy_boto3_iot.paginator import (\n    GetBehaviorModelTrainingSummariesPaginator,\n    ListActiveViolationsPaginator,\n    ListAttachedPoliciesPaginator,\n    ListAuditFindingsPaginator,\n    ListAuditMitigationActionsExecutionsPaginator,\n    ListAuditMitigationActionsTasksPaginator,\n    ListAuditSuppressionsPaginator,\n    ListAuditTasksPaginator,\n    ListAuthorizersPaginator,\n    ListBillingGroupsPaginator,\n    ListCACertificatesPaginator,\n    ListCertificatesPaginator,\n    ListCertificatesByCAPaginator,\n    ListCustomMetricsPaginator,\n    ListDetectMitigationActionsExecutionsPaginator,\n    ListDetectMitigationActionsTasksPaginator,\n    ListDimensionsPaginator,\n    ListDomainConfigurationsPaginator,\n    ListFleetMetricsPaginator,\n    ListIndicesPaginator,\n    ListJobExecutionsForJobPaginator,\n    ListJobExecutionsForThingPaginator,\n    ListJobTemplatesPaginator,\n    ListJobsPaginator,\n    ListManagedJobTemplatesPaginator,\n    ListMetricValuesPaginator,\n    ListMitigationActionsPaginator,\n    ListOTAUpdatesPaginator,\n    ListOutgoingCertificatesPaginator,\n    ListPackageVersionsPaginator,\n    ListPackagesPaginator,\n    ListPoliciesPaginator,\n    ListPolicyPrincipalsPaginator,\n    ListPrincipalPoliciesPaginator,\n    ListPrincipalThingsPaginator,\n    ListProvisioningTemplateVersionsPaginator,\n    ListProvisioningTemplatesPaginator,\n    ListRelatedResourcesForAuditFindingPaginator,\n    ListRoleAliasesPaginator,\n    ListSbomValidationResultsPaginator,\n    ListScheduledAuditsPaginator,\n    ListSecurityProfilesPaginator,\n    ListSecurityProfilesForTargetPaginator,\n    ListStreamsPaginator,\n    ListTagsForResourcePaginator,\n    ListTargetsForPolicyPaginator,\n    ListTargetsForSecurityProfilePaginator,\n    ListThingGroupsPaginator,\n    ListThingGroupsForThingPaginator,\n    ListThingPrincipalsPaginator,\n    ListThingRegistrationTaskReportsPaginator,\n    ListThingRegistrationTasksPaginator,\n    ListThingTypesPaginator,\n    ListThingsPaginator,\n    ListThingsInBillingGroupPaginator,\n    ListThingsInThingGroupPaginator,\n    ListTopicRuleDestinationsPaginator,\n    ListTopicRulesPaginator,\n    ListV2LoggingLevelsPaginator,\n    ListViolationEventsPaginator,\n)\n\nclient: IoTClient = Session().client(\"iot\")\n\n# Explicit type annotations are optional here\n# Types should be correctly discovered by mypy and IDEs\nget_behavior_model_training_summaries_paginator: GetBehaviorModelTrainingSummariesPaginator = (\n    client.get_paginator(\"get_behavior_model_training_summaries\")\n)\nlist_active_violations_paginator: ListActiveViolationsPaginator = client.get_paginator(\n    \"list_active_violations\"\n)\nlist_attached_policies_paginator: ListAttachedPoliciesPaginator = client.get_paginator(\n    \"list_attached_policies\"\n)\nlist_audit_findings_paginator: ListAuditFindingsPaginator = client.get_paginator(\n    \"list_audit_findings\"\n)\nlist_audit_mitigation_actions_executions_paginator: ListAuditMitigationActionsExecutionsPaginator = client.get_paginator(\n    \"list_audit_mitigation_actions_executions\"\n)\nlist_audit_mitigation_actions_tasks_paginator: ListAuditMitigationActionsTasksPaginator = (\n    client.get_paginator(\"list_audit_mitigation_actions_tasks\")\n)\nlist_audit_suppressions_paginator: ListAuditSuppressionsPaginator = client.get_paginator(\n    \"list_audit_suppressions\"\n)\nlist_audit_tasks_paginator: ListAuditTasksPaginator = client.get_paginator(\"list_audit_tasks\")\nlist_authorizers_paginator: ListAuthorizersPaginator = client.get_paginator(\"list_authorizers\")\nlist_billing_groups_paginator: ListBillingGroupsPaginator = client.get_paginator(\n    \"list_billing_groups\"\n)\nlist_ca_certificates_paginator: ListCACertificatesPaginator = client.get_paginator(\n    \"list_ca_certificates\"\n)\nlist_certificates_paginator: ListCertificatesPaginator = client.get_paginator(\"list_certificates\")\nlist_certificates_by_ca_paginator: ListCertificatesByCAPaginator = client.get_paginator(\n    \"list_certificates_by_ca\"\n)\nlist_custom_metrics_paginator: ListCustomMetricsPaginator = client.get_paginator(\n    \"list_custom_metrics\"\n)\nlist_detect_mitigation_actions_executions_paginator: ListDetectMitigationActionsExecutionsPaginator = client.get_paginator(\n    \"list_detect_mitigation_actions_executions\"\n)\nlist_detect_mitigation_actions_tasks_paginator: ListDetectMitigationActionsTasksPaginator = (\n    client.get_paginator(\"list_detect_mitigation_actions_tasks\")\n)\nlist_dimensions_paginator: ListDimensionsPaginator = client.get_paginator(\"list_dimensions\")\nlist_domain_configurations_paginator: ListDomainConfigurationsPaginator = client.get_paginator(\n    \"list_domain_configurations\"\n)\nlist_fleet_metrics_paginator: ListFleetMetricsPaginator = client.get_paginator(\"list_fleet_metrics\")\nlist_indices_paginator: ListIndicesPaginator = client.get_paginator(\"list_indices\")\nlist_job_executions_for_job_paginator: ListJobExecutionsForJobPaginator = client.get_paginator(\n    \"list_job_executions_for_job\"\n)\nlist_job_executions_for_thing_paginator: ListJobExecutionsForThingPaginator = client.get_paginator(\n    \"list_job_executions_for_thing\"\n)\nlist_job_templates_paginator: ListJobTemplatesPaginator = client.get_paginator(\"list_job_templates\")\nlist_jobs_paginator: ListJobsPaginator = client.get_paginator(\"list_jobs\")\nlist_managed_job_templates_paginator: ListManagedJobTemplatesPaginator = client.get_paginator(\n    \"list_managed_job_templates\"\n)\nlist_metric_values_paginator: ListMetricValuesPaginator = client.get_paginator(\"list_metric_values\")\nlist_mitigation_actions_paginator: ListMitigationActionsPaginator = client.get_paginator(\n    \"list_mitigation_actions\"\n)\nlist_ota_updates_paginator: ListOTAUpdatesPaginator = client.get_paginator(\"list_ota_updates\")\nlist_outgoing_certificates_paginator: ListOutgoingCertificatesPaginator = client.get_paginator(\n    \"list_outgoing_certificates\"\n)\nlist_package_versions_paginator: ListPackageVersionsPaginator = client.get_paginator(\n    \"list_package_versions\"\n)\nlist_packages_paginator: ListPackagesPaginator = client.get_paginator(\"list_packages\")\nlist_policies_paginator: ListPoliciesPaginator = client.get_paginator(\"list_policies\")\nlist_policy_principals_paginator: ListPolicyPrincipalsPaginator = client.get_paginator(\n    \"list_policy_principals\"\n)\nlist_principal_policies_paginator: ListPrincipalPoliciesPaginator = client.get_paginator(\n    \"list_principal_policies\"\n)\nlist_principal_things_paginator: ListPrincipalThingsPaginator = client.get_paginator(\n    \"list_principal_things\"\n)\nlist_provisioning_template_versions_paginator: ListProvisioningTemplateVersionsPaginator = (\n    client.get_paginator(\"list_provisioning_template_versions\")\n)\nlist_provisioning_templates_paginator: ListProvisioningTemplatesPaginator = client.get_paginator(\n    \"list_provisioning_templates\"\n)\nlist_related_resources_for_audit_finding_paginator: ListRelatedResourcesForAuditFindingPaginator = (\n    client.get_paginator(\"list_related_resources_for_audit_finding\")\n)\nlist_role_aliases_paginator: ListRoleAliasesPaginator = client.get_paginator(\"list_role_aliases\")\nlist_sbom_validation_results_paginator: ListSbomValidationResultsPaginator = client.get_paginator(\n    \"list_sbom_validation_results\"\n)\nlist_scheduled_audits_paginator: ListScheduledAuditsPaginator = client.get_paginator(\n    \"list_scheduled_audits\"\n)\nlist_security_profiles_paginator: ListSecurityProfilesPaginator = client.get_paginator(\n    \"list_security_profiles\"\n)\nlist_security_profiles_for_target_paginator: ListSecurityProfilesForTargetPaginator = (\n    client.get_paginator(\"list_security_profiles_for_target\")\n)\nlist_streams_paginator: ListStreamsPaginator = client.get_paginator(\"list_streams\")\nlist_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator(\n    \"list_tags_for_resource\"\n)\nlist_targets_for_policy_paginator: ListTargetsForPolicyPaginator = client.get_paginator(\n    \"list_targets_for_policy\"\n)\nlist_targets_for_security_profile_paginator: ListTargetsForSecurityProfilePaginator = (\n    client.get_paginator(\"list_targets_for_security_profile\")\n)\nlist_thing_groups_paginator: ListThingGroupsPaginator = client.get_paginator(\"list_thing_groups\")\nlist_thing_groups_for_thing_paginator: ListThingGroupsForThingPaginator = client.get_paginator(\n    \"list_thing_groups_for_thing\"\n)\nlist_thing_principals_paginator: ListThingPrincipalsPaginator = client.get_paginator(\n    \"list_thing_principals\"\n)\nlist_thing_registration_task_reports_paginator: ListThingRegistrationTaskReportsPaginator = (\n    client.get_paginator(\"list_thing_registration_task_reports\")\n)\nlist_thing_registration_tasks_paginator: ListThingRegistrationTasksPaginator = client.get_paginator(\n    \"list_thing_registration_tasks\"\n)\nlist_thing_types_paginator: ListThingTypesPaginator = client.get_paginator(\"list_thing_types\")\nlist_things_paginator: ListThingsPaginator = client.get_paginator(\"list_things\")\nlist_things_in_billing_group_paginator: ListThingsInBillingGroupPaginator = client.get_paginator(\n    \"list_things_in_billing_group\"\n)\nlist_things_in_thing_group_paginator: ListThingsInThingGroupPaginator = client.get_paginator(\n    \"list_things_in_thing_group\"\n)\nlist_topic_rule_destinations_paginator: ListTopicRuleDestinationsPaginator = client.get_paginator(\n    \"list_topic_rule_destinations\"\n)\nlist_topic_rules_paginator: ListTopicRulesPaginator = client.get_paginator(\"list_topic_rules\")\nlist_v2_logging_levels_paginator: ListV2LoggingLevelsPaginator = client.get_paginator(\n    \"list_v2_logging_levels\"\n)\nlist_violation_events_paginator: ListViolationEventsPaginator = client.get_paginator(\n    \"list_violation_events\"\n)\n```\n\n<a id=\"literals\"></a>\n\n### Literals\n\n`mypy_boto3_iot.literals` module contains literals extracted from shapes that\ncan be used in user code for type checking.\n\nFull list of `IoT` Literals can be found in\n[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iot/literals/).\n\n```python\nfrom mypy_boto3_iot.literals import AbortActionType\n\n\ndef check_value(value: AbortActionType) -> bool: ...\n```\n\n<a id=\"type-definitions\"></a>\n\n### Type definitions\n\n`mypy_boto3_iot.type_defs` module contains structures and shapes assembled to\ntyped dictionaries and unions for additional type checking.\n\nFull list of `IoT` TypeDefs can be found in\n[docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iot/type_defs/).\n\n```python\nfrom mypy_boto3_iot.type_defs import AbortCriteriaTypeDef\n\n\ndef get_value() -> AbortCriteriaTypeDef:\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 [ruff](https://docs.astral.sh/ruff/) 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-iot` 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_iot/)\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.IoT 1.35.33 service generated with mypy-boto3-builder 8.1.2",
    "version": "1.35.33",
    "project_urls": {
        "Documentation": "https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iot/",
        "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",
        "iot",
        "type-annotations",
        "botocore",
        "mypy",
        "typeshed",
        "autocomplete"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "48261ecafdc40f77606e31f0e31fe3345456dd086e87e4acc854e6c60ff1360d",
                "md5": "6e59e07a377b01b86b5cdb40d890687a",
                "sha256": "33b164ce908dd5206d11f7405a9cf3f8bc51ef0dd9e1ae31088c723e26c6280a"
            },
            "downloads": -1,
            "filename": "mypy_boto3_iot-1.35.33-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6e59e07a377b01b86b5cdb40d890687a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 116856,
            "upload_time": "2024-10-03T19:26:04",
            "upload_time_iso_8601": "2024-10-03T19:26:04.728236Z",
            "url": "https://files.pythonhosted.org/packages/48/26/1ecafdc40f77606e31f0e31fe3345456dd086e87e4acc854e6c60ff1360d/mypy_boto3_iot-1.35.33-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8662b7d702f540dfa347bd22d2ced72dede6c4ede38d44cbd8c0afef0a610e44",
                "md5": "c86523f20bc8ae60b92ef744c5fdaa69",
                "sha256": "e3e115a20f1452b97bd22c5c02f8aaacb50954caa65e3c97f347f3027f3486ca"
            },
            "downloads": -1,
            "filename": "mypy_boto3_iot-1.35.33.tar.gz",
            "has_sig": false,
            "md5_digest": "c86523f20bc8ae60b92ef744c5fdaa69",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 109319,
            "upload_time": "2024-10-03T19:26:07",
            "upload_time_iso_8601": "2024-10-03T19:26:07.193144Z",
            "url": "https://files.pythonhosted.org/packages/86/62/b7d702f540dfa347bd22d2ced72dede6c4ede38d44cbd8c0afef0a610e44/mypy_boto3_iot-1.35.33.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-03 19:26:07",
    "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-iot"
}