From bd58fbe64fb1d473a277be5cd177b043a1f01137 Mon Sep 17 00:00:00 2001 From: CoprDistGit Date: Tue, 11 Apr 2023 02:36:00 +0000 Subject: automatic import of python-mypy-boto3-cognito-idp --- .gitignore | 1 + python-mypy-boto3-cognito-idp.spec | 2164 ++++++++++++++++++++++++++++++++++++ sources | 1 + 3 files changed, 2166 insertions(+) create mode 100644 python-mypy-boto3-cognito-idp.spec create mode 100644 sources diff --git a/.gitignore b/.gitignore index e69de29..e00fa9d 100644 --- a/.gitignore +++ b/.gitignore @@ -0,0 +1 @@ +/mypy-boto3-cognito-idp-1.26.0.post1.tar.gz diff --git a/python-mypy-boto3-cognito-idp.spec b/python-mypy-boto3-cognito-idp.spec new file mode 100644 index 0000000..734a8e7 --- /dev/null +++ b/python-mypy-boto3-cognito-idp.spec @@ -0,0 +1,2164 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mypy-boto3-cognito-idp +Version: 1.26.0.post1 +Release: 1 +Summary: Type annotations for boto3.CognitoIdentityProvider 1.26.0 service generated with mypy-boto3-builder 7.11.10 +License: MIT License +URL: https://github.com/youtype/mypy_boto3_builder +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/5b/18/169d14f1a70aaccbd744a1deb095e1b99e06f0dfaadfc52fa7dab91478b1/mypy-boto3-cognito-idp-1.26.0.post1.tar.gz +BuildArch: noarch + +Requires: python3-typing-extensions + +%description + + +# 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/) +[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-cognito-idp?color=blue)](https://pypistats.org/packages/mypy-boto3-cognito-idp) + +![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png) + +Type annotations for +[boto3.CognitoIdentityProvider 1.26.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp.html#CognitoIdentityProvider) +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.11.10](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-cognito-idp docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cognito_idp/). + +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-cognito-idp](#mypy-boto3-cognito-idp) + - [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) + - [Typed dictionaries](#typed-dictionaries) + - [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) + + + +## How to install + + + +### 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 `CognitoIdentityProvider`. + + + +### From PyPI with pip + +Install `boto3-stubs` for `CognitoIdentityProvider` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[cognito-idp]' + + +# 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[cognito-idp]' + + +# standalone installation +python -m pip install mypy-boto3-cognito-idp +``` + + + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-cognito-idp +``` + + + +## Usage + + + +### 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[cognito-idp]` in your environment: + +```bash +python -m pip install 'boto3-stubs[cognito-idp]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + + + +### PyCharm + +Install `boto3-stubs-lite[cognito-idp]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[cognito-idp]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + + + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[cognito-idp]' +``` + +- 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. + + + +### Sublime Text + +- Install `boto3-stubs[cognito-idp]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[cognito-idp]' +``` + +- 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. + + + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + + + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[cognito-idp]` in your environment: + +```bash +python -m pip install 'boto3-stubs[cognito-idp]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + + + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[cognito-idp]` in your environment: + +```bash +python -m pip install 'boto3-stubs[cognito-idp]' +``` + +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. + + + +## Explicit type annotations + + + +### Client annotations + +`CognitoIdentityProviderClient` provides annotations for +`boto3.client("cognito-idp")`. + +```python +from boto3.session import Session + +from mypy_boto3_cognito_idp import CognitoIdentityProviderClient + +client: CognitoIdentityProviderClient = Session().client("cognito-idp") + +# now client usage is checked by mypy and IDE should provide code completion +``` + + + +### Paginators annotations + +`mypy_boto3_cognito_idp.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_cognito_idp import CognitoIdentityProviderClient +from mypy_boto3_cognito_idp.paginator import ( + AdminListGroupsForUserPaginator, + AdminListUserAuthEventsPaginator, + ListGroupsPaginator, + ListIdentityProvidersPaginator, + ListResourceServersPaginator, + ListUserPoolClientsPaginator, + ListUserPoolsPaginator, + ListUsersPaginator, + ListUsersInGroupPaginator, +) + +client: CognitoIdentityProviderClient = Session().client("cognito-idp") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +admin_list_groups_for_user_paginator: AdminListGroupsForUserPaginator = client.get_paginator( + "admin_list_groups_for_user" +) +admin_list_user_auth_events_paginator: AdminListUserAuthEventsPaginator = client.get_paginator( + "admin_list_user_auth_events" +) +list_groups_paginator: ListGroupsPaginator = client.get_paginator("list_groups") +list_identity_providers_paginator: ListIdentityProvidersPaginator = client.get_paginator( + "list_identity_providers" +) +list_resource_servers_paginator: ListResourceServersPaginator = client.get_paginator( + "list_resource_servers" +) +list_user_pool_clients_paginator: ListUserPoolClientsPaginator = client.get_paginator( + "list_user_pool_clients" +) +list_user_pools_paginator: ListUserPoolsPaginator = client.get_paginator("list_user_pools") +list_users_paginator: ListUsersPaginator = client.get_paginator("list_users") +list_users_in_group_paginator: ListUsersInGroupPaginator = client.get_paginator( + "list_users_in_group" +) +``` + + + +### Literals + +`mypy_boto3_cognito_idp.literals` module contains literals extracted from +shapes that can be used in user code for type checking. + +```python +from mypy_boto3_cognito_idp.literals import ( + AccountTakeoverEventActionTypeType, + AdminListGroupsForUserPaginatorName, + AdminListUserAuthEventsPaginatorName, + AdvancedSecurityModeTypeType, + AliasAttributeTypeType, + AttributeDataTypeType, + AuthFlowTypeType, + ChallengeNameType, + ChallengeNameTypeType, + ChallengeResponseType, + CompromisedCredentialsEventActionTypeType, + CustomEmailSenderLambdaVersionTypeType, + CustomSMSSenderLambdaVersionTypeType, + DefaultEmailOptionTypeType, + DeletionProtectionTypeType, + DeliveryMediumTypeType, + DeviceRememberedStatusTypeType, + DomainStatusTypeType, + EmailSendingAccountTypeType, + EventFilterTypeType, + EventResponseTypeType, + EventTypeType, + ExplicitAuthFlowsTypeType, + FeedbackValueTypeType, + IdentityProviderTypeTypeType, + ListGroupsPaginatorName, + ListIdentityProvidersPaginatorName, + ListResourceServersPaginatorName, + ListUserPoolClientsPaginatorName, + ListUserPoolsPaginatorName, + ListUsersInGroupPaginatorName, + ListUsersPaginatorName, + MessageActionTypeType, + OAuthFlowTypeType, + PreventUserExistenceErrorTypesType, + RecoveryOptionNameTypeType, + RiskDecisionTypeType, + RiskLevelTypeType, + StatusTypeType, + TimeUnitsTypeType, + UserImportJobStatusTypeType, + UserPoolMfaTypeType, + UserStatusTypeType, + UsernameAttributeTypeType, + VerifiedAttributeTypeType, + VerifySoftwareTokenResponseTypeType, + CognitoIdentityProviderServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: AccountTakeoverEventActionTypeType) -> bool: + ... +``` + + + +### Typed dictionaries + +`mypy_boto3_cognito_idp.type_defs` module contains structures and shapes +assembled to typed dictionaries for additional type checking. + +```python +from mypy_boto3_cognito_idp.type_defs import ( + RecoveryOptionTypeTypeDef, + AccountTakeoverActionTypeTypeDef, + AdminAddUserToGroupRequestRequestTypeDef, + AdminConfirmSignUpRequestRequestTypeDef, + MessageTemplateTypeTypeDef, + AttributeTypeTypeDef, + ResponseMetadataTypeDef, + AdminDeleteUserAttributesRequestRequestTypeDef, + AdminDeleteUserRequestRequestTypeDef, + ProviderUserIdentifierTypeTypeDef, + AdminDisableUserRequestRequestTypeDef, + AdminEnableUserRequestRequestTypeDef, + AdminForgetDeviceRequestRequestTypeDef, + AdminGetDeviceRequestRequestTypeDef, + AdminGetUserRequestRequestTypeDef, + MFAOptionTypeTypeDef, + AnalyticsMetadataTypeTypeDef, + AdminListDevicesRequestRequestTypeDef, + PaginatorConfigTypeDef, + AdminListGroupsForUserRequestRequestTypeDef, + GroupTypeTypeDef, + AdminListUserAuthEventsRequestRequestTypeDef, + AdminRemoveUserFromGroupRequestRequestTypeDef, + AdminResetUserPasswordRequestRequestTypeDef, + SMSMfaSettingsTypeTypeDef, + SoftwareTokenMfaSettingsTypeTypeDef, + AdminSetUserPasswordRequestRequestTypeDef, + AdminUpdateAuthEventFeedbackRequestRequestTypeDef, + AdminUpdateDeviceStatusRequestRequestTypeDef, + AdminUserGlobalSignOutRequestRequestTypeDef, + AnalyticsConfigurationTypeTypeDef, + AssociateSoftwareTokenRequestRequestTypeDef, + ChallengeResponseTypeTypeDef, + EventContextDataTypeTypeDef, + EventFeedbackTypeTypeDef, + EventRiskTypeTypeDef, + NewDeviceMetadataTypeTypeDef, + ChangePasswordRequestRequestTypeDef, + CodeDeliveryDetailsTypeTypeDef, + CompromisedCredentialsActionsTypeTypeDef, + DeviceSecretVerifierConfigTypeTypeDef, + UserContextDataTypeTypeDef, + HttpHeaderTypeDef, + CreateGroupRequestRequestTypeDef, + CreateIdentityProviderRequestRequestTypeDef, + IdentityProviderTypeTypeDef, + ResourceServerScopeTypeTypeDef, + CreateUserImportJobRequestRequestTypeDef, + UserImportJobTypeTypeDef, + TokenValidityUnitsTypeTypeDef, + CustomDomainConfigTypeTypeDef, + DeviceConfigurationTypeTypeDef, + EmailConfigurationTypeTypeDef, + SmsConfigurationTypeTypeDef, + UserAttributeUpdateSettingsTypeTypeDef, + UserPoolAddOnsTypeTypeDef, + UsernameConfigurationTypeTypeDef, + VerificationMessageTemplateTypeTypeDef, + CustomEmailLambdaVersionConfigTypeTypeDef, + CustomSMSLambdaVersionConfigTypeTypeDef, + DeleteGroupRequestRequestTypeDef, + DeleteIdentityProviderRequestRequestTypeDef, + DeleteResourceServerRequestRequestTypeDef, + DeleteUserAttributesRequestRequestTypeDef, + DeleteUserPoolClientRequestRequestTypeDef, + DeleteUserPoolDomainRequestRequestTypeDef, + DeleteUserPoolRequestRequestTypeDef, + DeleteUserRequestRequestTypeDef, + DescribeIdentityProviderRequestRequestTypeDef, + DescribeResourceServerRequestRequestTypeDef, + DescribeRiskConfigurationRequestRequestTypeDef, + DescribeUserImportJobRequestRequestTypeDef, + DescribeUserPoolClientRequestRequestTypeDef, + DescribeUserPoolDomainRequestRequestTypeDef, + DescribeUserPoolRequestRequestTypeDef, + ForgetDeviceRequestRequestTypeDef, + GetCSVHeaderRequestRequestTypeDef, + GetDeviceRequestRequestTypeDef, + GetGroupRequestRequestTypeDef, + GetIdentityProviderByIdentifierRequestRequestTypeDef, + GetSigningCertificateRequestRequestTypeDef, + GetUICustomizationRequestRequestTypeDef, + UICustomizationTypeTypeDef, + GetUserAttributeVerificationCodeRequestRequestTypeDef, + GetUserPoolMfaConfigRequestRequestTypeDef, + SoftwareTokenMfaConfigTypeTypeDef, + GetUserRequestRequestTypeDef, + GlobalSignOutRequestRequestTypeDef, + ListDevicesRequestRequestTypeDef, + ListGroupsRequestRequestTypeDef, + ListIdentityProvidersRequestRequestTypeDef, + ProviderDescriptionTypeDef, + ListResourceServersRequestRequestTypeDef, + ListTagsForResourceRequestRequestTypeDef, + ListUserImportJobsRequestRequestTypeDef, + ListUserPoolClientsRequestRequestTypeDef, + UserPoolClientDescriptionTypeDef, + ListUserPoolsRequestRequestTypeDef, + ListUsersInGroupRequestRequestTypeDef, + ListUsersRequestRequestTypeDef, + NotifyEmailTypeTypeDef, + NumberAttributeConstraintsTypeTypeDef, + PasswordPolicyTypeTypeDef, + RevokeTokenRequestRequestTypeDef, + RiskExceptionConfigurationTypeTypeDef, + StringAttributeConstraintsTypeTypeDef, + SetUICustomizationRequestRequestTypeDef, + StartUserImportJobRequestRequestTypeDef, + StopUserImportJobRequestRequestTypeDef, + TagResourceRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateAuthEventFeedbackRequestRequestTypeDef, + UpdateDeviceStatusRequestRequestTypeDef, + UpdateGroupRequestRequestTypeDef, + UpdateIdentityProviderRequestRequestTypeDef, + VerifySoftwareTokenRequestRequestTypeDef, + VerifyUserAttributeRequestRequestTypeDef, + AccountRecoverySettingTypeTypeDef, + AccountTakeoverActionsTypeTypeDef, + AdminCreateUserConfigTypeTypeDef, + AdminCreateUserRequestRequestTypeDef, + AdminUpdateUserAttributesRequestRequestTypeDef, + DeviceTypeTypeDef, + UpdateUserAttributesRequestRequestTypeDef, + AssociateSoftwareTokenResponseTypeDef, + ConfirmDeviceResponseTypeDef, + CreateUserPoolDomainResponseTypeDef, + EmptyResponseMetadataTypeDef, + GetCSVHeaderResponseTypeDef, + GetSigningCertificateResponseTypeDef, + ListTagsForResourceResponseTypeDef, + UpdateUserPoolDomainResponseTypeDef, + VerifySoftwareTokenResponseTypeDef, + AdminDisableProviderForUserRequestRequestTypeDef, + AdminLinkProviderForUserRequestRequestTypeDef, + AdminGetUserResponseTypeDef, + AdminSetUserSettingsRequestRequestTypeDef, + GetUserResponseTypeDef, + SetUserSettingsRequestRequestTypeDef, + UserTypeTypeDef, + AdminListGroupsForUserRequestAdminListGroupsForUserPaginateTypeDef, + AdminListUserAuthEventsRequestAdminListUserAuthEventsPaginateTypeDef, + ListGroupsRequestListGroupsPaginateTypeDef, + ListIdentityProvidersRequestListIdentityProvidersPaginateTypeDef, + ListResourceServersRequestListResourceServersPaginateTypeDef, + ListUserPoolClientsRequestListUserPoolClientsPaginateTypeDef, + ListUserPoolsRequestListUserPoolsPaginateTypeDef, + ListUsersInGroupRequestListUsersInGroupPaginateTypeDef, + ListUsersRequestListUsersPaginateTypeDef, + AdminListGroupsForUserResponseTypeDef, + CreateGroupResponseTypeDef, + GetGroupResponseTypeDef, + ListGroupsResponseTypeDef, + UpdateGroupResponseTypeDef, + AdminSetUserMFAPreferenceRequestRequestTypeDef, + SetUserMFAPreferenceRequestRequestTypeDef, + AuthEventTypeTypeDef, + AuthenticationResultTypeTypeDef, + ForgotPasswordResponseTypeDef, + GetUserAttributeVerificationCodeResponseTypeDef, + ResendConfirmationCodeResponseTypeDef, + SignUpResponseTypeDef, + UpdateUserAttributesResponseTypeDef, + CompromisedCredentialsRiskConfigurationTypeTypeDef, + ConfirmDeviceRequestRequestTypeDef, + ConfirmForgotPasswordRequestRequestTypeDef, + ConfirmSignUpRequestRequestTypeDef, + ForgotPasswordRequestRequestTypeDef, + InitiateAuthRequestRequestTypeDef, + ResendConfirmationCodeRequestRequestTypeDef, + RespondToAuthChallengeRequestRequestTypeDef, + SignUpRequestRequestTypeDef, + ContextDataTypeTypeDef, + CreateIdentityProviderResponseTypeDef, + DescribeIdentityProviderResponseTypeDef, + GetIdentityProviderByIdentifierResponseTypeDef, + UpdateIdentityProviderResponseTypeDef, + CreateResourceServerRequestRequestTypeDef, + ResourceServerTypeTypeDef, + UpdateResourceServerRequestRequestTypeDef, + CreateUserImportJobResponseTypeDef, + DescribeUserImportJobResponseTypeDef, + ListUserImportJobsResponseTypeDef, + StartUserImportJobResponseTypeDef, + StopUserImportJobResponseTypeDef, + CreateUserPoolClientRequestRequestTypeDef, + UpdateUserPoolClientRequestRequestTypeDef, + UserPoolClientTypeTypeDef, + CreateUserPoolDomainRequestRequestTypeDef, + DomainDescriptionTypeTypeDef, + UpdateUserPoolDomainRequestRequestTypeDef, + SmsMfaConfigTypeTypeDef, + LambdaConfigTypeTypeDef, + GetUICustomizationResponseTypeDef, + SetUICustomizationResponseTypeDef, + ListIdentityProvidersResponseTypeDef, + ListUserPoolClientsResponseTypeDef, + NotifyConfigurationTypeTypeDef, + UserPoolPolicyTypeTypeDef, + SchemaAttributeTypeTypeDef, + AdminGetDeviceResponseTypeDef, + AdminListDevicesResponseTypeDef, + GetDeviceResponseTypeDef, + ListDevicesResponseTypeDef, + AdminCreateUserResponseTypeDef, + ListUsersInGroupResponseTypeDef, + ListUsersResponseTypeDef, + AdminListUserAuthEventsResponseTypeDef, + AdminInitiateAuthResponseTypeDef, + AdminRespondToAuthChallengeResponseTypeDef, + InitiateAuthResponseTypeDef, + RespondToAuthChallengeResponseTypeDef, + AdminInitiateAuthRequestRequestTypeDef, + AdminRespondToAuthChallengeRequestRequestTypeDef, + CreateResourceServerResponseTypeDef, + DescribeResourceServerResponseTypeDef, + ListResourceServersResponseTypeDef, + UpdateResourceServerResponseTypeDef, + CreateUserPoolClientResponseTypeDef, + DescribeUserPoolClientResponseTypeDef, + UpdateUserPoolClientResponseTypeDef, + DescribeUserPoolDomainResponseTypeDef, + GetUserPoolMfaConfigResponseTypeDef, + SetUserPoolMfaConfigRequestRequestTypeDef, + SetUserPoolMfaConfigResponseTypeDef, + UserPoolDescriptionTypeTypeDef, + AccountTakeoverRiskConfigurationTypeTypeDef, + UpdateUserPoolRequestRequestTypeDef, + AddCustomAttributesRequestRequestTypeDef, + CreateUserPoolRequestRequestTypeDef, + UserPoolTypeTypeDef, + ListUserPoolsResponseTypeDef, + RiskConfigurationTypeTypeDef, + SetRiskConfigurationRequestRequestTypeDef, + CreateUserPoolResponseTypeDef, + DescribeUserPoolResponseTypeDef, + DescribeRiskConfigurationResponseTypeDef, + SetRiskConfigurationResponseTypeDef, +) + + +def get_structure() -> RecoveryOptionTypeTypeDef: + return {...} +``` + + + +## 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 a 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 the documentation (blame `botocore` docs if types + are incorrect). +- 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. + + + +## What's new + + + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` 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.session` calls +- Auto discovery of types for `session.client` and `session.session` 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 + + + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + + + +## Versioning + +`mypy-boto3-cognito-idp` version is the same as related `boto3` version and +follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + + + +## 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 + + + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cognito_idp/) + + + +## 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. + + +%package -n python3-mypy-boto3-cognito-idp +Summary: Type annotations for boto3.CognitoIdentityProvider 1.26.0 service generated with mypy-boto3-builder 7.11.10 +Provides: python-mypy-boto3-cognito-idp +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mypy-boto3-cognito-idp + + +# 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/) +[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-cognito-idp?color=blue)](https://pypistats.org/packages/mypy-boto3-cognito-idp) + +![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png) + +Type annotations for +[boto3.CognitoIdentityProvider 1.26.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp.html#CognitoIdentityProvider) +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.11.10](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-cognito-idp docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cognito_idp/). + +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-cognito-idp](#mypy-boto3-cognito-idp) + - [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) + - [Typed dictionaries](#typed-dictionaries) + - [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) + + + +## How to install + + + +### 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 `CognitoIdentityProvider`. + + + +### From PyPI with pip + +Install `boto3-stubs` for `CognitoIdentityProvider` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[cognito-idp]' + + +# 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[cognito-idp]' + + +# standalone installation +python -m pip install mypy-boto3-cognito-idp +``` + + + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-cognito-idp +``` + + + +## Usage + + + +### 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[cognito-idp]` in your environment: + +```bash +python -m pip install 'boto3-stubs[cognito-idp]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + + + +### PyCharm + +Install `boto3-stubs-lite[cognito-idp]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[cognito-idp]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + + + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[cognito-idp]' +``` + +- 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. + + + +### Sublime Text + +- Install `boto3-stubs[cognito-idp]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[cognito-idp]' +``` + +- 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. + + + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + + + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[cognito-idp]` in your environment: + +```bash +python -m pip install 'boto3-stubs[cognito-idp]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + + + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[cognito-idp]` in your environment: + +```bash +python -m pip install 'boto3-stubs[cognito-idp]' +``` + +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. + + + +## Explicit type annotations + + + +### Client annotations + +`CognitoIdentityProviderClient` provides annotations for +`boto3.client("cognito-idp")`. + +```python +from boto3.session import Session + +from mypy_boto3_cognito_idp import CognitoIdentityProviderClient + +client: CognitoIdentityProviderClient = Session().client("cognito-idp") + +# now client usage is checked by mypy and IDE should provide code completion +``` + + + +### Paginators annotations + +`mypy_boto3_cognito_idp.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_cognito_idp import CognitoIdentityProviderClient +from mypy_boto3_cognito_idp.paginator import ( + AdminListGroupsForUserPaginator, + AdminListUserAuthEventsPaginator, + ListGroupsPaginator, + ListIdentityProvidersPaginator, + ListResourceServersPaginator, + ListUserPoolClientsPaginator, + ListUserPoolsPaginator, + ListUsersPaginator, + ListUsersInGroupPaginator, +) + +client: CognitoIdentityProviderClient = Session().client("cognito-idp") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +admin_list_groups_for_user_paginator: AdminListGroupsForUserPaginator = client.get_paginator( + "admin_list_groups_for_user" +) +admin_list_user_auth_events_paginator: AdminListUserAuthEventsPaginator = client.get_paginator( + "admin_list_user_auth_events" +) +list_groups_paginator: ListGroupsPaginator = client.get_paginator("list_groups") +list_identity_providers_paginator: ListIdentityProvidersPaginator = client.get_paginator( + "list_identity_providers" +) +list_resource_servers_paginator: ListResourceServersPaginator = client.get_paginator( + "list_resource_servers" +) +list_user_pool_clients_paginator: ListUserPoolClientsPaginator = client.get_paginator( + "list_user_pool_clients" +) +list_user_pools_paginator: ListUserPoolsPaginator = client.get_paginator("list_user_pools") +list_users_paginator: ListUsersPaginator = client.get_paginator("list_users") +list_users_in_group_paginator: ListUsersInGroupPaginator = client.get_paginator( + "list_users_in_group" +) +``` + + + +### Literals + +`mypy_boto3_cognito_idp.literals` module contains literals extracted from +shapes that can be used in user code for type checking. + +```python +from mypy_boto3_cognito_idp.literals import ( + AccountTakeoverEventActionTypeType, + AdminListGroupsForUserPaginatorName, + AdminListUserAuthEventsPaginatorName, + AdvancedSecurityModeTypeType, + AliasAttributeTypeType, + AttributeDataTypeType, + AuthFlowTypeType, + ChallengeNameType, + ChallengeNameTypeType, + ChallengeResponseType, + CompromisedCredentialsEventActionTypeType, + CustomEmailSenderLambdaVersionTypeType, + CustomSMSSenderLambdaVersionTypeType, + DefaultEmailOptionTypeType, + DeletionProtectionTypeType, + DeliveryMediumTypeType, + DeviceRememberedStatusTypeType, + DomainStatusTypeType, + EmailSendingAccountTypeType, + EventFilterTypeType, + EventResponseTypeType, + EventTypeType, + ExplicitAuthFlowsTypeType, + FeedbackValueTypeType, + IdentityProviderTypeTypeType, + ListGroupsPaginatorName, + ListIdentityProvidersPaginatorName, + ListResourceServersPaginatorName, + ListUserPoolClientsPaginatorName, + ListUserPoolsPaginatorName, + ListUsersInGroupPaginatorName, + ListUsersPaginatorName, + MessageActionTypeType, + OAuthFlowTypeType, + PreventUserExistenceErrorTypesType, + RecoveryOptionNameTypeType, + RiskDecisionTypeType, + RiskLevelTypeType, + StatusTypeType, + TimeUnitsTypeType, + UserImportJobStatusTypeType, + UserPoolMfaTypeType, + UserStatusTypeType, + UsernameAttributeTypeType, + VerifiedAttributeTypeType, + VerifySoftwareTokenResponseTypeType, + CognitoIdentityProviderServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: AccountTakeoverEventActionTypeType) -> bool: + ... +``` + + + +### Typed dictionaries + +`mypy_boto3_cognito_idp.type_defs` module contains structures and shapes +assembled to typed dictionaries for additional type checking. + +```python +from mypy_boto3_cognito_idp.type_defs import ( + RecoveryOptionTypeTypeDef, + AccountTakeoverActionTypeTypeDef, + AdminAddUserToGroupRequestRequestTypeDef, + AdminConfirmSignUpRequestRequestTypeDef, + MessageTemplateTypeTypeDef, + AttributeTypeTypeDef, + ResponseMetadataTypeDef, + AdminDeleteUserAttributesRequestRequestTypeDef, + AdminDeleteUserRequestRequestTypeDef, + ProviderUserIdentifierTypeTypeDef, + AdminDisableUserRequestRequestTypeDef, + AdminEnableUserRequestRequestTypeDef, + AdminForgetDeviceRequestRequestTypeDef, + AdminGetDeviceRequestRequestTypeDef, + AdminGetUserRequestRequestTypeDef, + MFAOptionTypeTypeDef, + AnalyticsMetadataTypeTypeDef, + AdminListDevicesRequestRequestTypeDef, + PaginatorConfigTypeDef, + AdminListGroupsForUserRequestRequestTypeDef, + GroupTypeTypeDef, + AdminListUserAuthEventsRequestRequestTypeDef, + AdminRemoveUserFromGroupRequestRequestTypeDef, + AdminResetUserPasswordRequestRequestTypeDef, + SMSMfaSettingsTypeTypeDef, + SoftwareTokenMfaSettingsTypeTypeDef, + AdminSetUserPasswordRequestRequestTypeDef, + AdminUpdateAuthEventFeedbackRequestRequestTypeDef, + AdminUpdateDeviceStatusRequestRequestTypeDef, + AdminUserGlobalSignOutRequestRequestTypeDef, + AnalyticsConfigurationTypeTypeDef, + AssociateSoftwareTokenRequestRequestTypeDef, + ChallengeResponseTypeTypeDef, + EventContextDataTypeTypeDef, + EventFeedbackTypeTypeDef, + EventRiskTypeTypeDef, + NewDeviceMetadataTypeTypeDef, + ChangePasswordRequestRequestTypeDef, + CodeDeliveryDetailsTypeTypeDef, + CompromisedCredentialsActionsTypeTypeDef, + DeviceSecretVerifierConfigTypeTypeDef, + UserContextDataTypeTypeDef, + HttpHeaderTypeDef, + CreateGroupRequestRequestTypeDef, + CreateIdentityProviderRequestRequestTypeDef, + IdentityProviderTypeTypeDef, + ResourceServerScopeTypeTypeDef, + CreateUserImportJobRequestRequestTypeDef, + UserImportJobTypeTypeDef, + TokenValidityUnitsTypeTypeDef, + CustomDomainConfigTypeTypeDef, + DeviceConfigurationTypeTypeDef, + EmailConfigurationTypeTypeDef, + SmsConfigurationTypeTypeDef, + UserAttributeUpdateSettingsTypeTypeDef, + UserPoolAddOnsTypeTypeDef, + UsernameConfigurationTypeTypeDef, + VerificationMessageTemplateTypeTypeDef, + CustomEmailLambdaVersionConfigTypeTypeDef, + CustomSMSLambdaVersionConfigTypeTypeDef, + DeleteGroupRequestRequestTypeDef, + DeleteIdentityProviderRequestRequestTypeDef, + DeleteResourceServerRequestRequestTypeDef, + DeleteUserAttributesRequestRequestTypeDef, + DeleteUserPoolClientRequestRequestTypeDef, + DeleteUserPoolDomainRequestRequestTypeDef, + DeleteUserPoolRequestRequestTypeDef, + DeleteUserRequestRequestTypeDef, + DescribeIdentityProviderRequestRequestTypeDef, + DescribeResourceServerRequestRequestTypeDef, + DescribeRiskConfigurationRequestRequestTypeDef, + DescribeUserImportJobRequestRequestTypeDef, + DescribeUserPoolClientRequestRequestTypeDef, + DescribeUserPoolDomainRequestRequestTypeDef, + DescribeUserPoolRequestRequestTypeDef, + ForgetDeviceRequestRequestTypeDef, + GetCSVHeaderRequestRequestTypeDef, + GetDeviceRequestRequestTypeDef, + GetGroupRequestRequestTypeDef, + GetIdentityProviderByIdentifierRequestRequestTypeDef, + GetSigningCertificateRequestRequestTypeDef, + GetUICustomizationRequestRequestTypeDef, + UICustomizationTypeTypeDef, + GetUserAttributeVerificationCodeRequestRequestTypeDef, + GetUserPoolMfaConfigRequestRequestTypeDef, + SoftwareTokenMfaConfigTypeTypeDef, + GetUserRequestRequestTypeDef, + GlobalSignOutRequestRequestTypeDef, + ListDevicesRequestRequestTypeDef, + ListGroupsRequestRequestTypeDef, + ListIdentityProvidersRequestRequestTypeDef, + ProviderDescriptionTypeDef, + ListResourceServersRequestRequestTypeDef, + ListTagsForResourceRequestRequestTypeDef, + ListUserImportJobsRequestRequestTypeDef, + ListUserPoolClientsRequestRequestTypeDef, + UserPoolClientDescriptionTypeDef, + ListUserPoolsRequestRequestTypeDef, + ListUsersInGroupRequestRequestTypeDef, + ListUsersRequestRequestTypeDef, + NotifyEmailTypeTypeDef, + NumberAttributeConstraintsTypeTypeDef, + PasswordPolicyTypeTypeDef, + RevokeTokenRequestRequestTypeDef, + RiskExceptionConfigurationTypeTypeDef, + StringAttributeConstraintsTypeTypeDef, + SetUICustomizationRequestRequestTypeDef, + StartUserImportJobRequestRequestTypeDef, + StopUserImportJobRequestRequestTypeDef, + TagResourceRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateAuthEventFeedbackRequestRequestTypeDef, + UpdateDeviceStatusRequestRequestTypeDef, + UpdateGroupRequestRequestTypeDef, + UpdateIdentityProviderRequestRequestTypeDef, + VerifySoftwareTokenRequestRequestTypeDef, + VerifyUserAttributeRequestRequestTypeDef, + AccountRecoverySettingTypeTypeDef, + AccountTakeoverActionsTypeTypeDef, + AdminCreateUserConfigTypeTypeDef, + AdminCreateUserRequestRequestTypeDef, + AdminUpdateUserAttributesRequestRequestTypeDef, + DeviceTypeTypeDef, + UpdateUserAttributesRequestRequestTypeDef, + AssociateSoftwareTokenResponseTypeDef, + ConfirmDeviceResponseTypeDef, + CreateUserPoolDomainResponseTypeDef, + EmptyResponseMetadataTypeDef, + GetCSVHeaderResponseTypeDef, + GetSigningCertificateResponseTypeDef, + ListTagsForResourceResponseTypeDef, + UpdateUserPoolDomainResponseTypeDef, + VerifySoftwareTokenResponseTypeDef, + AdminDisableProviderForUserRequestRequestTypeDef, + AdminLinkProviderForUserRequestRequestTypeDef, + AdminGetUserResponseTypeDef, + AdminSetUserSettingsRequestRequestTypeDef, + GetUserResponseTypeDef, + SetUserSettingsRequestRequestTypeDef, + UserTypeTypeDef, + AdminListGroupsForUserRequestAdminListGroupsForUserPaginateTypeDef, + AdminListUserAuthEventsRequestAdminListUserAuthEventsPaginateTypeDef, + ListGroupsRequestListGroupsPaginateTypeDef, + ListIdentityProvidersRequestListIdentityProvidersPaginateTypeDef, + ListResourceServersRequestListResourceServersPaginateTypeDef, + ListUserPoolClientsRequestListUserPoolClientsPaginateTypeDef, + ListUserPoolsRequestListUserPoolsPaginateTypeDef, + ListUsersInGroupRequestListUsersInGroupPaginateTypeDef, + ListUsersRequestListUsersPaginateTypeDef, + AdminListGroupsForUserResponseTypeDef, + CreateGroupResponseTypeDef, + GetGroupResponseTypeDef, + ListGroupsResponseTypeDef, + UpdateGroupResponseTypeDef, + AdminSetUserMFAPreferenceRequestRequestTypeDef, + SetUserMFAPreferenceRequestRequestTypeDef, + AuthEventTypeTypeDef, + AuthenticationResultTypeTypeDef, + ForgotPasswordResponseTypeDef, + GetUserAttributeVerificationCodeResponseTypeDef, + ResendConfirmationCodeResponseTypeDef, + SignUpResponseTypeDef, + UpdateUserAttributesResponseTypeDef, + CompromisedCredentialsRiskConfigurationTypeTypeDef, + ConfirmDeviceRequestRequestTypeDef, + ConfirmForgotPasswordRequestRequestTypeDef, + ConfirmSignUpRequestRequestTypeDef, + ForgotPasswordRequestRequestTypeDef, + InitiateAuthRequestRequestTypeDef, + ResendConfirmationCodeRequestRequestTypeDef, + RespondToAuthChallengeRequestRequestTypeDef, + SignUpRequestRequestTypeDef, + ContextDataTypeTypeDef, + CreateIdentityProviderResponseTypeDef, + DescribeIdentityProviderResponseTypeDef, + GetIdentityProviderByIdentifierResponseTypeDef, + UpdateIdentityProviderResponseTypeDef, + CreateResourceServerRequestRequestTypeDef, + ResourceServerTypeTypeDef, + UpdateResourceServerRequestRequestTypeDef, + CreateUserImportJobResponseTypeDef, + DescribeUserImportJobResponseTypeDef, + ListUserImportJobsResponseTypeDef, + StartUserImportJobResponseTypeDef, + StopUserImportJobResponseTypeDef, + CreateUserPoolClientRequestRequestTypeDef, + UpdateUserPoolClientRequestRequestTypeDef, + UserPoolClientTypeTypeDef, + CreateUserPoolDomainRequestRequestTypeDef, + DomainDescriptionTypeTypeDef, + UpdateUserPoolDomainRequestRequestTypeDef, + SmsMfaConfigTypeTypeDef, + LambdaConfigTypeTypeDef, + GetUICustomizationResponseTypeDef, + SetUICustomizationResponseTypeDef, + ListIdentityProvidersResponseTypeDef, + ListUserPoolClientsResponseTypeDef, + NotifyConfigurationTypeTypeDef, + UserPoolPolicyTypeTypeDef, + SchemaAttributeTypeTypeDef, + AdminGetDeviceResponseTypeDef, + AdminListDevicesResponseTypeDef, + GetDeviceResponseTypeDef, + ListDevicesResponseTypeDef, + AdminCreateUserResponseTypeDef, + ListUsersInGroupResponseTypeDef, + ListUsersResponseTypeDef, + AdminListUserAuthEventsResponseTypeDef, + AdminInitiateAuthResponseTypeDef, + AdminRespondToAuthChallengeResponseTypeDef, + InitiateAuthResponseTypeDef, + RespondToAuthChallengeResponseTypeDef, + AdminInitiateAuthRequestRequestTypeDef, + AdminRespondToAuthChallengeRequestRequestTypeDef, + CreateResourceServerResponseTypeDef, + DescribeResourceServerResponseTypeDef, + ListResourceServersResponseTypeDef, + UpdateResourceServerResponseTypeDef, + CreateUserPoolClientResponseTypeDef, + DescribeUserPoolClientResponseTypeDef, + UpdateUserPoolClientResponseTypeDef, + DescribeUserPoolDomainResponseTypeDef, + GetUserPoolMfaConfigResponseTypeDef, + SetUserPoolMfaConfigRequestRequestTypeDef, + SetUserPoolMfaConfigResponseTypeDef, + UserPoolDescriptionTypeTypeDef, + AccountTakeoverRiskConfigurationTypeTypeDef, + UpdateUserPoolRequestRequestTypeDef, + AddCustomAttributesRequestRequestTypeDef, + CreateUserPoolRequestRequestTypeDef, + UserPoolTypeTypeDef, + ListUserPoolsResponseTypeDef, + RiskConfigurationTypeTypeDef, + SetRiskConfigurationRequestRequestTypeDef, + CreateUserPoolResponseTypeDef, + DescribeUserPoolResponseTypeDef, + DescribeRiskConfigurationResponseTypeDef, + SetRiskConfigurationResponseTypeDef, +) + + +def get_structure() -> RecoveryOptionTypeTypeDef: + return {...} +``` + + + +## 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 a 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 the documentation (blame `botocore` docs if types + are incorrect). +- 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. + + + +## What's new + + + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` 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.session` calls +- Auto discovery of types for `session.client` and `session.session` 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 + + + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + + + +## Versioning + +`mypy-boto3-cognito-idp` version is the same as related `boto3` version and +follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + + + +## 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 + + + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cognito_idp/) + + + +## 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. + + +%package help +Summary: Development documents and examples for mypy-boto3-cognito-idp +Provides: python3-mypy-boto3-cognito-idp-doc +%description help + + +# 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/) +[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-cognito-idp?color=blue)](https://pypistats.org/packages/mypy-boto3-cognito-idp) + +![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png) + +Type annotations for +[boto3.CognitoIdentityProvider 1.26.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp.html#CognitoIdentityProvider) +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.11.10](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-cognito-idp docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cognito_idp/). + +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-cognito-idp](#mypy-boto3-cognito-idp) + - [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) + - [Typed dictionaries](#typed-dictionaries) + - [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) + + + +## How to install + + + +### 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 `CognitoIdentityProvider`. + + + +### From PyPI with pip + +Install `boto3-stubs` for `CognitoIdentityProvider` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[cognito-idp]' + + +# 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[cognito-idp]' + + +# standalone installation +python -m pip install mypy-boto3-cognito-idp +``` + + + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-cognito-idp +``` + + + +## Usage + + + +### 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[cognito-idp]` in your environment: + +```bash +python -m pip install 'boto3-stubs[cognito-idp]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + + + +### PyCharm + +Install `boto3-stubs-lite[cognito-idp]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[cognito-idp]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + + + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[cognito-idp]' +``` + +- 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. + + + +### Sublime Text + +- Install `boto3-stubs[cognito-idp]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[cognito-idp]' +``` + +- 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. + + + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + + + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[cognito-idp]` in your environment: + +```bash +python -m pip install 'boto3-stubs[cognito-idp]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + + + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[cognito-idp]` in your environment: + +```bash +python -m pip install 'boto3-stubs[cognito-idp]' +``` + +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. + + + +## Explicit type annotations + + + +### Client annotations + +`CognitoIdentityProviderClient` provides annotations for +`boto3.client("cognito-idp")`. + +```python +from boto3.session import Session + +from mypy_boto3_cognito_idp import CognitoIdentityProviderClient + +client: CognitoIdentityProviderClient = Session().client("cognito-idp") + +# now client usage is checked by mypy and IDE should provide code completion +``` + + + +### Paginators annotations + +`mypy_boto3_cognito_idp.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_cognito_idp import CognitoIdentityProviderClient +from mypy_boto3_cognito_idp.paginator import ( + AdminListGroupsForUserPaginator, + AdminListUserAuthEventsPaginator, + ListGroupsPaginator, + ListIdentityProvidersPaginator, + ListResourceServersPaginator, + ListUserPoolClientsPaginator, + ListUserPoolsPaginator, + ListUsersPaginator, + ListUsersInGroupPaginator, +) + +client: CognitoIdentityProviderClient = Session().client("cognito-idp") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +admin_list_groups_for_user_paginator: AdminListGroupsForUserPaginator = client.get_paginator( + "admin_list_groups_for_user" +) +admin_list_user_auth_events_paginator: AdminListUserAuthEventsPaginator = client.get_paginator( + "admin_list_user_auth_events" +) +list_groups_paginator: ListGroupsPaginator = client.get_paginator("list_groups") +list_identity_providers_paginator: ListIdentityProvidersPaginator = client.get_paginator( + "list_identity_providers" +) +list_resource_servers_paginator: ListResourceServersPaginator = client.get_paginator( + "list_resource_servers" +) +list_user_pool_clients_paginator: ListUserPoolClientsPaginator = client.get_paginator( + "list_user_pool_clients" +) +list_user_pools_paginator: ListUserPoolsPaginator = client.get_paginator("list_user_pools") +list_users_paginator: ListUsersPaginator = client.get_paginator("list_users") +list_users_in_group_paginator: ListUsersInGroupPaginator = client.get_paginator( + "list_users_in_group" +) +``` + + + +### Literals + +`mypy_boto3_cognito_idp.literals` module contains literals extracted from +shapes that can be used in user code for type checking. + +```python +from mypy_boto3_cognito_idp.literals import ( + AccountTakeoverEventActionTypeType, + AdminListGroupsForUserPaginatorName, + AdminListUserAuthEventsPaginatorName, + AdvancedSecurityModeTypeType, + AliasAttributeTypeType, + AttributeDataTypeType, + AuthFlowTypeType, + ChallengeNameType, + ChallengeNameTypeType, + ChallengeResponseType, + CompromisedCredentialsEventActionTypeType, + CustomEmailSenderLambdaVersionTypeType, + CustomSMSSenderLambdaVersionTypeType, + DefaultEmailOptionTypeType, + DeletionProtectionTypeType, + DeliveryMediumTypeType, + DeviceRememberedStatusTypeType, + DomainStatusTypeType, + EmailSendingAccountTypeType, + EventFilterTypeType, + EventResponseTypeType, + EventTypeType, + ExplicitAuthFlowsTypeType, + FeedbackValueTypeType, + IdentityProviderTypeTypeType, + ListGroupsPaginatorName, + ListIdentityProvidersPaginatorName, + ListResourceServersPaginatorName, + ListUserPoolClientsPaginatorName, + ListUserPoolsPaginatorName, + ListUsersInGroupPaginatorName, + ListUsersPaginatorName, + MessageActionTypeType, + OAuthFlowTypeType, + PreventUserExistenceErrorTypesType, + RecoveryOptionNameTypeType, + RiskDecisionTypeType, + RiskLevelTypeType, + StatusTypeType, + TimeUnitsTypeType, + UserImportJobStatusTypeType, + UserPoolMfaTypeType, + UserStatusTypeType, + UsernameAttributeTypeType, + VerifiedAttributeTypeType, + VerifySoftwareTokenResponseTypeType, + CognitoIdentityProviderServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: AccountTakeoverEventActionTypeType) -> bool: + ... +``` + + + +### Typed dictionaries + +`mypy_boto3_cognito_idp.type_defs` module contains structures and shapes +assembled to typed dictionaries for additional type checking. + +```python +from mypy_boto3_cognito_idp.type_defs import ( + RecoveryOptionTypeTypeDef, + AccountTakeoverActionTypeTypeDef, + AdminAddUserToGroupRequestRequestTypeDef, + AdminConfirmSignUpRequestRequestTypeDef, + MessageTemplateTypeTypeDef, + AttributeTypeTypeDef, + ResponseMetadataTypeDef, + AdminDeleteUserAttributesRequestRequestTypeDef, + AdminDeleteUserRequestRequestTypeDef, + ProviderUserIdentifierTypeTypeDef, + AdminDisableUserRequestRequestTypeDef, + AdminEnableUserRequestRequestTypeDef, + AdminForgetDeviceRequestRequestTypeDef, + AdminGetDeviceRequestRequestTypeDef, + AdminGetUserRequestRequestTypeDef, + MFAOptionTypeTypeDef, + AnalyticsMetadataTypeTypeDef, + AdminListDevicesRequestRequestTypeDef, + PaginatorConfigTypeDef, + AdminListGroupsForUserRequestRequestTypeDef, + GroupTypeTypeDef, + AdminListUserAuthEventsRequestRequestTypeDef, + AdminRemoveUserFromGroupRequestRequestTypeDef, + AdminResetUserPasswordRequestRequestTypeDef, + SMSMfaSettingsTypeTypeDef, + SoftwareTokenMfaSettingsTypeTypeDef, + AdminSetUserPasswordRequestRequestTypeDef, + AdminUpdateAuthEventFeedbackRequestRequestTypeDef, + AdminUpdateDeviceStatusRequestRequestTypeDef, + AdminUserGlobalSignOutRequestRequestTypeDef, + AnalyticsConfigurationTypeTypeDef, + AssociateSoftwareTokenRequestRequestTypeDef, + ChallengeResponseTypeTypeDef, + EventContextDataTypeTypeDef, + EventFeedbackTypeTypeDef, + EventRiskTypeTypeDef, + NewDeviceMetadataTypeTypeDef, + ChangePasswordRequestRequestTypeDef, + CodeDeliveryDetailsTypeTypeDef, + CompromisedCredentialsActionsTypeTypeDef, + DeviceSecretVerifierConfigTypeTypeDef, + UserContextDataTypeTypeDef, + HttpHeaderTypeDef, + CreateGroupRequestRequestTypeDef, + CreateIdentityProviderRequestRequestTypeDef, + IdentityProviderTypeTypeDef, + ResourceServerScopeTypeTypeDef, + CreateUserImportJobRequestRequestTypeDef, + UserImportJobTypeTypeDef, + TokenValidityUnitsTypeTypeDef, + CustomDomainConfigTypeTypeDef, + DeviceConfigurationTypeTypeDef, + EmailConfigurationTypeTypeDef, + SmsConfigurationTypeTypeDef, + UserAttributeUpdateSettingsTypeTypeDef, + UserPoolAddOnsTypeTypeDef, + UsernameConfigurationTypeTypeDef, + VerificationMessageTemplateTypeTypeDef, + CustomEmailLambdaVersionConfigTypeTypeDef, + CustomSMSLambdaVersionConfigTypeTypeDef, + DeleteGroupRequestRequestTypeDef, + DeleteIdentityProviderRequestRequestTypeDef, + DeleteResourceServerRequestRequestTypeDef, + DeleteUserAttributesRequestRequestTypeDef, + DeleteUserPoolClientRequestRequestTypeDef, + DeleteUserPoolDomainRequestRequestTypeDef, + DeleteUserPoolRequestRequestTypeDef, + DeleteUserRequestRequestTypeDef, + DescribeIdentityProviderRequestRequestTypeDef, + DescribeResourceServerRequestRequestTypeDef, + DescribeRiskConfigurationRequestRequestTypeDef, + DescribeUserImportJobRequestRequestTypeDef, + DescribeUserPoolClientRequestRequestTypeDef, + DescribeUserPoolDomainRequestRequestTypeDef, + DescribeUserPoolRequestRequestTypeDef, + ForgetDeviceRequestRequestTypeDef, + GetCSVHeaderRequestRequestTypeDef, + GetDeviceRequestRequestTypeDef, + GetGroupRequestRequestTypeDef, + GetIdentityProviderByIdentifierRequestRequestTypeDef, + GetSigningCertificateRequestRequestTypeDef, + GetUICustomizationRequestRequestTypeDef, + UICustomizationTypeTypeDef, + GetUserAttributeVerificationCodeRequestRequestTypeDef, + GetUserPoolMfaConfigRequestRequestTypeDef, + SoftwareTokenMfaConfigTypeTypeDef, + GetUserRequestRequestTypeDef, + GlobalSignOutRequestRequestTypeDef, + ListDevicesRequestRequestTypeDef, + ListGroupsRequestRequestTypeDef, + ListIdentityProvidersRequestRequestTypeDef, + ProviderDescriptionTypeDef, + ListResourceServersRequestRequestTypeDef, + ListTagsForResourceRequestRequestTypeDef, + ListUserImportJobsRequestRequestTypeDef, + ListUserPoolClientsRequestRequestTypeDef, + UserPoolClientDescriptionTypeDef, + ListUserPoolsRequestRequestTypeDef, + ListUsersInGroupRequestRequestTypeDef, + ListUsersRequestRequestTypeDef, + NotifyEmailTypeTypeDef, + NumberAttributeConstraintsTypeTypeDef, + PasswordPolicyTypeTypeDef, + RevokeTokenRequestRequestTypeDef, + RiskExceptionConfigurationTypeTypeDef, + StringAttributeConstraintsTypeTypeDef, + SetUICustomizationRequestRequestTypeDef, + StartUserImportJobRequestRequestTypeDef, + StopUserImportJobRequestRequestTypeDef, + TagResourceRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateAuthEventFeedbackRequestRequestTypeDef, + UpdateDeviceStatusRequestRequestTypeDef, + UpdateGroupRequestRequestTypeDef, + UpdateIdentityProviderRequestRequestTypeDef, + VerifySoftwareTokenRequestRequestTypeDef, + VerifyUserAttributeRequestRequestTypeDef, + AccountRecoverySettingTypeTypeDef, + AccountTakeoverActionsTypeTypeDef, + AdminCreateUserConfigTypeTypeDef, + AdminCreateUserRequestRequestTypeDef, + AdminUpdateUserAttributesRequestRequestTypeDef, + DeviceTypeTypeDef, + UpdateUserAttributesRequestRequestTypeDef, + AssociateSoftwareTokenResponseTypeDef, + ConfirmDeviceResponseTypeDef, + CreateUserPoolDomainResponseTypeDef, + EmptyResponseMetadataTypeDef, + GetCSVHeaderResponseTypeDef, + GetSigningCertificateResponseTypeDef, + ListTagsForResourceResponseTypeDef, + UpdateUserPoolDomainResponseTypeDef, + VerifySoftwareTokenResponseTypeDef, + AdminDisableProviderForUserRequestRequestTypeDef, + AdminLinkProviderForUserRequestRequestTypeDef, + AdminGetUserResponseTypeDef, + AdminSetUserSettingsRequestRequestTypeDef, + GetUserResponseTypeDef, + SetUserSettingsRequestRequestTypeDef, + UserTypeTypeDef, + AdminListGroupsForUserRequestAdminListGroupsForUserPaginateTypeDef, + AdminListUserAuthEventsRequestAdminListUserAuthEventsPaginateTypeDef, + ListGroupsRequestListGroupsPaginateTypeDef, + ListIdentityProvidersRequestListIdentityProvidersPaginateTypeDef, + ListResourceServersRequestListResourceServersPaginateTypeDef, + ListUserPoolClientsRequestListUserPoolClientsPaginateTypeDef, + ListUserPoolsRequestListUserPoolsPaginateTypeDef, + ListUsersInGroupRequestListUsersInGroupPaginateTypeDef, + ListUsersRequestListUsersPaginateTypeDef, + AdminListGroupsForUserResponseTypeDef, + CreateGroupResponseTypeDef, + GetGroupResponseTypeDef, + ListGroupsResponseTypeDef, + UpdateGroupResponseTypeDef, + AdminSetUserMFAPreferenceRequestRequestTypeDef, + SetUserMFAPreferenceRequestRequestTypeDef, + AuthEventTypeTypeDef, + AuthenticationResultTypeTypeDef, + ForgotPasswordResponseTypeDef, + GetUserAttributeVerificationCodeResponseTypeDef, + ResendConfirmationCodeResponseTypeDef, + SignUpResponseTypeDef, + UpdateUserAttributesResponseTypeDef, + CompromisedCredentialsRiskConfigurationTypeTypeDef, + ConfirmDeviceRequestRequestTypeDef, + ConfirmForgotPasswordRequestRequestTypeDef, + ConfirmSignUpRequestRequestTypeDef, + ForgotPasswordRequestRequestTypeDef, + InitiateAuthRequestRequestTypeDef, + ResendConfirmationCodeRequestRequestTypeDef, + RespondToAuthChallengeRequestRequestTypeDef, + SignUpRequestRequestTypeDef, + ContextDataTypeTypeDef, + CreateIdentityProviderResponseTypeDef, + DescribeIdentityProviderResponseTypeDef, + GetIdentityProviderByIdentifierResponseTypeDef, + UpdateIdentityProviderResponseTypeDef, + CreateResourceServerRequestRequestTypeDef, + ResourceServerTypeTypeDef, + UpdateResourceServerRequestRequestTypeDef, + CreateUserImportJobResponseTypeDef, + DescribeUserImportJobResponseTypeDef, + ListUserImportJobsResponseTypeDef, + StartUserImportJobResponseTypeDef, + StopUserImportJobResponseTypeDef, + CreateUserPoolClientRequestRequestTypeDef, + UpdateUserPoolClientRequestRequestTypeDef, + UserPoolClientTypeTypeDef, + CreateUserPoolDomainRequestRequestTypeDef, + DomainDescriptionTypeTypeDef, + UpdateUserPoolDomainRequestRequestTypeDef, + SmsMfaConfigTypeTypeDef, + LambdaConfigTypeTypeDef, + GetUICustomizationResponseTypeDef, + SetUICustomizationResponseTypeDef, + ListIdentityProvidersResponseTypeDef, + ListUserPoolClientsResponseTypeDef, + NotifyConfigurationTypeTypeDef, + UserPoolPolicyTypeTypeDef, + SchemaAttributeTypeTypeDef, + AdminGetDeviceResponseTypeDef, + AdminListDevicesResponseTypeDef, + GetDeviceResponseTypeDef, + ListDevicesResponseTypeDef, + AdminCreateUserResponseTypeDef, + ListUsersInGroupResponseTypeDef, + ListUsersResponseTypeDef, + AdminListUserAuthEventsResponseTypeDef, + AdminInitiateAuthResponseTypeDef, + AdminRespondToAuthChallengeResponseTypeDef, + InitiateAuthResponseTypeDef, + RespondToAuthChallengeResponseTypeDef, + AdminInitiateAuthRequestRequestTypeDef, + AdminRespondToAuthChallengeRequestRequestTypeDef, + CreateResourceServerResponseTypeDef, + DescribeResourceServerResponseTypeDef, + ListResourceServersResponseTypeDef, + UpdateResourceServerResponseTypeDef, + CreateUserPoolClientResponseTypeDef, + DescribeUserPoolClientResponseTypeDef, + UpdateUserPoolClientResponseTypeDef, + DescribeUserPoolDomainResponseTypeDef, + GetUserPoolMfaConfigResponseTypeDef, + SetUserPoolMfaConfigRequestRequestTypeDef, + SetUserPoolMfaConfigResponseTypeDef, + UserPoolDescriptionTypeTypeDef, + AccountTakeoverRiskConfigurationTypeTypeDef, + UpdateUserPoolRequestRequestTypeDef, + AddCustomAttributesRequestRequestTypeDef, + CreateUserPoolRequestRequestTypeDef, + UserPoolTypeTypeDef, + ListUserPoolsResponseTypeDef, + RiskConfigurationTypeTypeDef, + SetRiskConfigurationRequestRequestTypeDef, + CreateUserPoolResponseTypeDef, + DescribeUserPoolResponseTypeDef, + DescribeRiskConfigurationResponseTypeDef, + SetRiskConfigurationResponseTypeDef, +) + + +def get_structure() -> RecoveryOptionTypeTypeDef: + return {...} +``` + + + +## 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 a 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 the documentation (blame `botocore` docs if types + are incorrect). +- 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. + + + +## What's new + + + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` 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.session` calls +- Auto discovery of types for `session.client` and `session.session` 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 + + + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + + + +## Versioning + +`mypy-boto3-cognito-idp` version is the same as related `boto3` version and +follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + + + +## 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 + + + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_cognito_idp/) + + + +## 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. + + +%prep +%autosetup -n mypy-boto3-cognito-idp-1.26.0.post1 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-mypy-boto3-cognito-idp -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot - 1.26.0.post1-1 +- Package Spec generated diff --git a/sources b/sources new file mode 100644 index 0000000..0b65e5c --- /dev/null +++ b/sources @@ -0,0 +1 @@ +4e3bb9642bf8e3d135bce3fcb0f88b92 mypy-boto3-cognito-idp-1.26.0.post1.tar.gz -- cgit v1.2.3