types-aiobotocore-sqs


Nametypes-aiobotocore-sqs JSON
Version 2.12.3 PyPI version JSON
download
home_pagehttps://github.com/youtype/mypy_boto3_builder
SummaryType annotations for aiobotocore.SQS 2.12.3 service generated with mypy-boto3-builder 7.23.2
upload_time2024-04-12 01:33:39
maintainerNone
docs_urlNone
authorVlad Emelianov
requires_python>=3.8
licenseMIT License
keywords aiobotocore sqs 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="types-aiobotocore-sqs"></a>

# types-aiobotocore-sqs

[![PyPI - types-aiobotocore-sqs](https://img.shields.io/pypi/v/types-aiobotocore-sqs.svg?color=blue)](https://pypi.org/project/types-aiobotocore-sqs)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-aiobotocore-sqs.svg?color=blue)](https://pypi.org/project/types-aiobotocore-sqs)
[![Docs](https://img.shields.io/readthedocs/types-aiobotocore.svg?color=blue)](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_sqs/)
[![PyPI - Downloads](https://static.pepy.tech/badge/types-aiobotocore-sqs)](https://pepy.tech/project/types-aiobotocore-sqs)

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

Type annotations for
[aiobotocore.SQS 2.12.3](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sqs.html#SQS)
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.23.2](https://github.com/youtype/mypy_boto3_builder).

More information can be found on
[types-aiobotocore](https://pypi.org/project/types-aiobotocore/) page and in
[types-aiobotocore-sqs docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_sqs/).

See how it helps to find and fix potential bugs:

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

- [types-aiobotocore-sqs](#types-aiobotocore-sqs)
  - [How to install](#how-to-install)
    - [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)
    - [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="from-pypi-with-pip"></a>

### From PyPI with pip

Install `types-aiobotocore` for `SQS` service.

```bash
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[sqs]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[sqs]'


# standalone installation
python -m pip install types-aiobotocore-sqs
```

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

## How to uninstall

```bash
python -m pip uninstall -y types-aiobotocore-sqs
```

<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 `types-aiobotocore[sqs]` in your environment:

```bash
python -m pip install 'types-aiobotocore[sqs]'
```

Both type checking and code completion should now work. No explicit type
annotations required, write your `aiobotocore` code as usual.

<a id="pycharm"></a>

### PyCharm

Install `types-aiobotocore-lite[sqs]` in your environment:

```bash
python -m pip install 'types-aiobotocore-lite[sqs]'`
```

Both type checking and code completion should now work. Explicit type
annotations **are required**.

Use `types-aiobotocore` package instead for implicit type discovery.

<a id="emacs"></a>

### Emacs

- Install `types-aiobotocore` with services you use in your environment:

```bash
python -m pip install 'types-aiobotocore[sqs]'
```

- 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
  `types-aiobotocore`

Type checking should now work. No explicit type annotations required, write
your `aiobotocore` code as usual.

<a id="sublime-text"></a>

### Sublime Text

- Install `types-aiobotocore[sqs]` with services you use in your environment:

```bash
python -m pip install 'types-aiobotocore[sqs]'
```

- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package

Type checking should now work. No explicit type annotations required, write
your `aiobotocore` 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 `types-aiobotocore[sqs]` in your environment:

```bash
python -m pip install 'types-aiobotocore[sqs]'`
```

Type checking should now work. No explicit type annotations required, write
your `aiobotocore` code as usual.

<a id="pyright"></a>

### pyright

- Install `pyright`: `npm i -g pyright`
- Install `types-aiobotocore[sqs]` in your environment:

```bash
python -m pip install 'types-aiobotocore[sqs]'
```

Optionally, you can install `types-aiobotocore` to `typings` folder.

Type checking should now work. No explicit type annotations required, write
your `aiobotocore` code as usual.

<a id="explicit-type-annotations"></a>

## Explicit type annotations

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

### Client annotations

`SQSClient` provides annotations for `session.create_client("sqs")`.

```python
from aiobotocore.session import get_session

from types_aiobotocore_sqs import SQSClient

session = get_session()
async with session.create_client("sqs") as client:
    client: SQSClient
    # now client usage is checked by mypy and IDE should provide code completion
```

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

### Paginators annotations

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

```python
from aiobotocore.session import get_session

from types_aiobotocore_sqs import SQSClient
from types_aiobotocore_sqs.paginator import ListDeadLetterSourceQueuesPaginator, ListQueuesPaginator

session = get_session()
async with session.create_client("sqs") as client:
    client: SQSClient

    # Explicit type annotations are optional here
    # Types should be correctly discovered by mypy and IDEs
    list_dead_letter_source_queues_paginator: ListDeadLetterSourceQueuesPaginator = (
        client.get_paginator("list_dead_letter_source_queues")
    )
    list_queues_paginator: ListQueuesPaginator = client.get_paginator("list_queues")
```

<a id="service-resource-annotations"></a>

### Service Resource annotations

`SQSServiceResource` provides annotations for `aiobotocore.resource("sqs")`.

```python
from aiobotocore.session import get_session

from types_aiobotocore_sqs import SQSServiceResource

session = get_session()
async with session.resource("sqs") as resource:
    resource: SQSServiceResource
    # now resource usage is checked by mypy and IDE should provide code completion
```

<a id="other-resources-annotations"></a>

### Other resources annotations

`types_aiobotocore_sqs.service_resource` module contains type annotations for
all resources.

```python
from aiobotocore.session import get_session

from types_aiobotocore_sqs import SQSServiceResource
from types_aiobotocore_sqs.service_resource import Message, Queue

session = get_session()
async with session.resource("sqs") as resource:
    resource: SQSServiceResource

    # Explicit type annotations are optional here
    # Type should be correctly discovered by mypy and IDEs
    my_message: Message = resource.Message(...)
    my_queue: Queue = resource.Queue(...)
```

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

### Collections annotations

`types_aiobotocore_sqs.service_resource` module contains type annotations for
all `SQSServiceResource` collections.

```python
from aiobotocore.session import get_session

from types_aiobotocore_sqs import SQSServiceResource
from types_aiobotocore_sqs.service_resource import ServiceResourceQueuesCollection

session = get_session()
async with session.resource("sqs") as resource:
    resource: SQSServiceResource

    # Explicit type annotations are optional here
    # Type should be correctly discovered by mypy and IDEs
    queues: sqs_resources.ServiceResourceQueuesCollection = resource.queues
```

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

### Literals

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

Full list of `SQS` Literals can be found in
[docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_sqs/literals/).

```python
from types_aiobotocore_sqs.literals import ListDeadLetterSourceQueuesPaginatorName


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

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

### Type definitions

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

Full list of `SQS` TypeDefs can be found in
[docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_sqs/type_defs/).

```python
from types_aiobotocore_sqs.type_defs import AddPermissionRequestQueueAddPermissionTypeDef


def get_value() -> AddPermissionRequestQueueAddPermissionTypeDef:
    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
`aiobotocore` updates. It delivers drop-in type annotations for you and makes
sure that:

- All available `aiobotocore` services are covered.
- Each public class and method of every `aiobotocore` 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

`types-aiobotocore-sqs` version is the same as related `aiobotocore` 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
[aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_sqs/)

<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": "types-aiobotocore-sqs",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "aiobotocore sqs type-annotations botocore mypy typeshed autocomplete",
    "author": "Vlad Emelianov",
    "author_email": "vlad.emelianov.nz@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/53/1d/59a9b3d0d954fc223bb4544f0d5d41992c67ba5512c432b44ebab9c1c4f9/types-aiobotocore-sqs-2.12.3.tar.gz",
    "platform": null,
    "description": "<a id=\"types-aiobotocore-sqs\"></a>\n\n# types-aiobotocore-sqs\n\n[![PyPI - types-aiobotocore-sqs](https://img.shields.io/pypi/v/types-aiobotocore-sqs.svg?color=blue)](https://pypi.org/project/types-aiobotocore-sqs)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-aiobotocore-sqs.svg?color=blue)](https://pypi.org/project/types-aiobotocore-sqs)\n[![Docs](https://img.shields.io/readthedocs/types-aiobotocore.svg?color=blue)](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_sqs/)\n[![PyPI - Downloads](https://static.pepy.tech/badge/types-aiobotocore-sqs)](https://pepy.tech/project/types-aiobotocore-sqs)\n\n![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)\n\nType annotations for\n[aiobotocore.SQS 2.12.3](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sqs.html#SQS)\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.23.2](https://github.com/youtype/mypy_boto3_builder).\n\nMore information can be found on\n[types-aiobotocore](https://pypi.org/project/types-aiobotocore/) page and in\n[types-aiobotocore-sqs docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_sqs/).\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- [types-aiobotocore-sqs](#types-aiobotocore-sqs)\n  - [How to install](#how-to-install)\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    - [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=\"from-pypi-with-pip\"></a>\n\n### From PyPI with pip\n\nInstall `types-aiobotocore` for `SQS` service.\n\n```bash\n# install with aiobotocore type annotations\npython -m pip install 'types-aiobotocore[sqs]'\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 'types-aiobotocore-lite[sqs]'\n\n\n# standalone installation\npython -m pip install types-aiobotocore-sqs\n```\n\n<a id=\"how-to-uninstall\"></a>\n\n## How to uninstall\n\n```bash\npython -m pip uninstall -y types-aiobotocore-sqs\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 `types-aiobotocore[sqs]` in your environment:\n\n```bash\npython -m pip install 'types-aiobotocore[sqs]'\n```\n\nBoth type checking and code completion should now work. No explicit type\nannotations required, write your `aiobotocore` code as usual.\n\n<a id=\"pycharm\"></a>\n\n### PyCharm\n\nInstall `types-aiobotocore-lite[sqs]` in your environment:\n\n```bash\npython -m pip install 'types-aiobotocore-lite[sqs]'`\n```\n\nBoth type checking and code completion should now work. Explicit type\nannotations **are required**.\n\nUse `types-aiobotocore` package instead for implicit type discovery.\n\n<a id=\"emacs\"></a>\n\n### Emacs\n\n- Install `types-aiobotocore` with services you use in your environment:\n\n```bash\npython -m pip install 'types-aiobotocore[sqs]'\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\n  `types-aiobotocore`\n\nType checking should now work. No explicit type annotations required, write\nyour `aiobotocore` code as usual.\n\n<a id=\"sublime-text\"></a>\n\n### Sublime Text\n\n- Install `types-aiobotocore[sqs]` with services you use in your environment:\n\n```bash\npython -m pip install 'types-aiobotocore[sqs]'\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 `aiobotocore` 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 `types-aiobotocore[sqs]` in your environment:\n\n```bash\npython -m pip install 'types-aiobotocore[sqs]'`\n```\n\nType checking should now work. No explicit type annotations required, write\nyour `aiobotocore` code as usual.\n\n<a id=\"pyright\"></a>\n\n### pyright\n\n- Install `pyright`: `npm i -g pyright`\n- Install `types-aiobotocore[sqs]` in your environment:\n\n```bash\npython -m pip install 'types-aiobotocore[sqs]'\n```\n\nOptionally, you can install `types-aiobotocore` to `typings` folder.\n\nType checking should now work. No explicit type annotations required, write\nyour `aiobotocore` 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`SQSClient` provides annotations for `session.create_client(\"sqs\")`.\n\n```python\nfrom aiobotocore.session import get_session\n\nfrom types_aiobotocore_sqs import SQSClient\n\nsession = get_session()\nasync with session.create_client(\"sqs\") as client:\n    client: SQSClient\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`types_aiobotocore_sqs.paginator` module contains type annotations for all\npaginators.\n\n```python\nfrom aiobotocore.session import get_session\n\nfrom types_aiobotocore_sqs import SQSClient\nfrom types_aiobotocore_sqs.paginator import ListDeadLetterSourceQueuesPaginator, ListQueuesPaginator\n\nsession = get_session()\nasync with session.create_client(\"sqs\") as client:\n    client: SQSClient\n\n    # Explicit type annotations are optional here\n    # Types should be correctly discovered by mypy and IDEs\n    list_dead_letter_source_queues_paginator: ListDeadLetterSourceQueuesPaginator = (\n        client.get_paginator(\"list_dead_letter_source_queues\")\n    )\n    list_queues_paginator: ListQueuesPaginator = client.get_paginator(\"list_queues\")\n```\n\n<a id=\"service-resource-annotations\"></a>\n\n### Service Resource annotations\n\n`SQSServiceResource` provides annotations for `aiobotocore.resource(\"sqs\")`.\n\n```python\nfrom aiobotocore.session import get_session\n\nfrom types_aiobotocore_sqs import SQSServiceResource\n\nsession = get_session()\nasync with session.resource(\"sqs\") as resource:\n    resource: SQSServiceResource\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`types_aiobotocore_sqs.service_resource` module contains type annotations for\nall resources.\n\n```python\nfrom aiobotocore.session import get_session\n\nfrom types_aiobotocore_sqs import SQSServiceResource\nfrom types_aiobotocore_sqs.service_resource import Message, Queue\n\nsession = get_session()\nasync with session.resource(\"sqs\") as resource:\n    resource: SQSServiceResource\n\n    # Explicit type annotations are optional here\n    # Type should be correctly discovered by mypy and IDEs\n    my_message: Message = resource.Message(...)\n    my_queue: Queue = resource.Queue(...)\n```\n\n<a id=\"collections-annotations\"></a>\n\n### Collections annotations\n\n`types_aiobotocore_sqs.service_resource` module contains type annotations for\nall `SQSServiceResource` collections.\n\n```python\nfrom aiobotocore.session import get_session\n\nfrom types_aiobotocore_sqs import SQSServiceResource\nfrom types_aiobotocore_sqs.service_resource import ServiceResourceQueuesCollection\n\nsession = get_session()\nasync with session.resource(\"sqs\") as resource:\n    resource: SQSServiceResource\n\n    # Explicit type annotations are optional here\n    # Type should be correctly discovered by mypy and IDEs\n    queues: sqs_resources.ServiceResourceQueuesCollection = resource.queues\n```\n\n<a id=\"literals\"></a>\n\n### Literals\n\n`types_aiobotocore_sqs.literals` module contains literals extracted from shapes\nthat can be used in user code for type checking.\n\nFull list of `SQS` Literals can be found in\n[docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_sqs/literals/).\n\n```python\nfrom types_aiobotocore_sqs.literals import ListDeadLetterSourceQueuesPaginatorName\n\n\ndef check_value(value: ListDeadLetterSourceQueuesPaginatorName) -> bool: ...\n```\n\n<a id=\"type-definitions\"></a>\n\n### Type definitions\n\n`types_aiobotocore_sqs.type_defs` module contains structures and shapes\nassembled to typed dictionaries and unions for additional type checking.\n\nFull list of `SQS` TypeDefs can be found in\n[docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_sqs/type_defs/).\n\n```python\nfrom types_aiobotocore_sqs.type_defs import AddPermissionRequestQueueAddPermissionTypeDef\n\n\ndef get_value() -> AddPermissionRequestQueueAddPermissionTypeDef:\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\n`aiobotocore` updates. It delivers drop-in type annotations for you and makes\nsure that:\n\n- All available `aiobotocore` services are covered.\n- Each public class and method of every `aiobotocore` 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`types-aiobotocore-sqs` version is the same as related `aiobotocore` version\nand follows [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[aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_sqs/)\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 aiobotocore.SQS 2.12.3 service generated with mypy-boto3-builder 7.23.2",
    "version": "2.12.3",
    "project_urls": {
        "Documentation": "https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_sqs/",
        "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": [
        "aiobotocore",
        "sqs",
        "type-annotations",
        "botocore",
        "mypy",
        "typeshed",
        "autocomplete"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "af89e9b34a82a3c024cd2c514ae9539d9dbcd67da6904856ab9ff6172e5ef662",
                "md5": "dd8b261cef9890c96239a021c2f2c586",
                "sha256": "9c229e3e5ae6accd0759f13ee4cf03ae6f3990609d21d795cec6ec7121396b98"
            },
            "downloads": -1,
            "filename": "types_aiobotocore_sqs-2.12.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "dd8b261cef9890c96239a021c2f2c586",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 33253,
            "upload_time": "2024-04-12T01:33:36",
            "upload_time_iso_8601": "2024-04-12T01:33:36.612759Z",
            "url": "https://files.pythonhosted.org/packages/af/89/e9b34a82a3c024cd2c514ae9539d9dbcd67da6904856ab9ff6172e5ef662/types_aiobotocore_sqs-2.12.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "531d59a9b3d0d954fc223bb4544f0d5d41992c67ba5512c432b44ebab9c1c4f9",
                "md5": "e7aee684e5db8604da02edd4fc405d6d",
                "sha256": "9b8b5c5995e58b1c94440ed5d5b26f4e10b557274f99a96a21dcfb26baac125d"
            },
            "downloads": -1,
            "filename": "types-aiobotocore-sqs-2.12.3.tar.gz",
            "has_sig": false,
            "md5_digest": "e7aee684e5db8604da02edd4fc405d6d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 21959,
            "upload_time": "2024-04-12T01:33:39",
            "upload_time_iso_8601": "2024-04-12T01:33:39.045709Z",
            "url": "https://files.pythonhosted.org/packages/53/1d/59a9b3d0d954fc223bb4544f0d5d41992c67ba5512c432b44ebab9c1c4f9/types-aiobotocore-sqs-2.12.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-12 01:33:39",
    "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": "types-aiobotocore-sqs"
}
        
Elapsed time: 0.24525s