Metadata-Version: 2.1
Name: mypy-boto3-cognito-idp
Version: 1.13.26.1
Summary: Type annotations for boto3.CognitoIdentityProvider 1.13.26 service, generated by mypy-boto3-buider 2.0.3
Home-page: https://github.com/vemel/mypy_boto3_builder
Author: Vlad Emelianov
Author-email: vlad.emelianov.nz@gmail.com
License: MIT License
Project-URL: Documentation, https://mypy-boto3-builder.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/vemel/mypy_boto3_builder
Project-URL: Tracker, https://github.com/vemel/mypy_boto3_builder/issues
Keywords: boto3 cognito-idp type-annotations boto3-stubs mypy typeshed autocomplete auto-generated
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: typing-extensions ; python_version < "3.8"

# mypy-boto3-cognito-idp

[![PyPI - mypy-boto3-cognito-idp](https://img.shields.io/pypi/v/mypy-boto3-cognito-idp.svg?color=blue)](https://pypi.org/project/mypy-boto3-cognito-idp)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-cognito-idp.svg?color=blue)](https://pypi.org/project/mypy-boto3-cognito-idp)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)

- [mypy-boto3-cognito-idp](#mypy-boto3-cognito-idp)
  - [How to use](#how-to-use)
  - [Automated type discovery](#automated-type-discovery)


Type annotations for
[boto3.CognitoIdentityProvider 1.13.26](https://boto3.amazonaws.com/v1/documentation/api/1.13.26/reference/services/cognito-idp.html#CognitoIdentityProvider) 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.0.3](https://github.com/vemel/mypy_boto3_builder).

More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page.

- [mypy-boto3-cognito-idp](#mypy-boto3-cognito-idp)
  - [How to use](#how-to-use)
    - [Type checking](#type-checking)
  - [How it works](#how-it-works)

## How to use

Make sure you have [mypy](https://github.com/python/mypy) installed and activated in your IDE.

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

```bash
python -m pip install boto3-stubs[cognito-idp]

# update installed packages index for automated type discovery
python -m mypy_boto3
```

Use `boto3` with `mypy_boto3_cognito_idp` in your project and enjoy type checking and auto-complete.

```python
import boto3

from mypy_boto3_cognito_idp import CognitoIdentityProviderClient

# Now mypy can check if your code is valid.
client: CognitoIdentityProviderClient = boto3.client("cognito-idp")

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: CognitoIdentityProviderClient = session.client("cognito-idp")



# Annotated paginators are included as well

import mypy_boto3_cognito_idp.paginator as cognito_idp_paginators

admin_list_groups_for_user_paginator: cognito_idp_paginators.AdminListGroupsForUserPaginator = client.get_paginator("admin_list_groups_for_user")
admin_list_user_auth_events_paginator: cognito_idp_paginators.AdminListUserAuthEventsPaginator = client.get_paginator("admin_list_user_auth_events")
list_groups_paginator: cognito_idp_paginators.ListGroupsPaginator = client.get_paginator("list_groups")
list_identity_providers_paginator: cognito_idp_paginators.ListIdentityProvidersPaginator = client.get_paginator("list_identity_providers")
list_resource_servers_paginator: cognito_idp_paginators.ListResourceServersPaginator = client.get_paginator("list_resource_servers")
list_user_pool_clients_paginator: cognito_idp_paginators.ListUserPoolClientsPaginator = client.get_paginator("list_user_pool_clients")
list_user_pools_paginator: cognito_idp_paginators.ListUserPoolsPaginator = client.get_paginator("list_user_pools")
list_users_paginator: cognito_idp_paginators.ListUsersPaginator = client.get_paginator("list_users")
list_users_in_group_paginator: cognito_idp_paginators.ListUsersInGroupPaginator = client.get_paginator("list_users_in_group")
```

## Automated type discovery

`mypy_boto3` package can generate index for `mypy_boto3_cognito_idp` and other installed services.

```bash
# Run this command when you add or remove service packages
python -m mypy_boto3
```

Generated index provides overloads for `boto3.client` and `boto3.service`,
`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
- `VSCode` does not currently support function overloads

Also, generated index allows you to import types from `mypy_boto3`:

```python
# you can replace imports
import mypy_boto3_cognito_idp as cognito_idp
from mypy_boto3_cognito_idp import CognitoIdentityProviderClient

# with these
from mypy_boto3 import cognito_idp
from mypy_boto3.cognito_idp import CognitoIdentityProviderClient
```

