types-boto3-full 1.35.77__py3-none-any.whl → 1.35.79__py3-none-any.whl

types_boto3_cognito_idp/client.py

@@ -357,7 +357,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[AdminConfirmSignUpRequestRequestTypeDef]
     ) -> Dict[str, Any]:
         """
-        This IAM-authenticated API operation confirms user sign-up as an administrator.
+        Confirms user sign-up as an administrator.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/admin_confirm_sign_up.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#admin_confirm_sign_up)
@@ -377,7 +377,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[AdminDeleteUserRequestRequestTypeDef]
     ) -> EmptyResponseMetadataTypeDef:
         """
-        Deletes a user as an administrator.
+        Deletes a user profile in your user pool.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/admin_delete_user.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#admin_delete_user)
@@ -387,7 +387,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[AdminDeleteUserAttributesRequestRequestTypeDef]
     ) -> Dict[str, Any]:
         """
-        Deletes the user attributes in a user pool as an administrator.
+        Deletes attribute values from a user.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/admin_delete_user_attributes.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#admin_delete_user_attributes)
@@ -408,7 +408,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[AdminDisableUserRequestRequestTypeDef]
     ) -> Dict[str, Any]:
         """
-        Deactivates a user and revokes all access tokens for the user.
+        Deactivates a user profile and revokes all access tokens for the user.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/admin_disable_user.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#admin_disable_user)
@@ -418,7 +418,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[AdminEnableUserRequestRequestTypeDef]
     ) -> Dict[str, Any]:
         """
-        Enables the specified user as an administrator.
+        Activate sign-in for a user profile that previously had sign-in access disabled.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/admin_enable_user.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#admin_enable_user)
@@ -428,7 +428,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[AdminForgetDeviceRequestRequestTypeDef]
     ) -> EmptyResponseMetadataTypeDef:
         """
-        Forgets the device, as an administrator.
+        Forgets, or deletes, a remembered device from a user's profile.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/admin_forget_device.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#admin_forget_device)
@@ -438,7 +438,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[AdminGetDeviceRequestRequestTypeDef]
     ) -> AdminGetDeviceResponseTypeDef:
         """
-        Gets the device, as an administrator.
+        Given the device key, returns details for a user' device.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/admin_get_device.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#admin_get_device)
@@ -448,7 +448,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[AdminGetUserRequestRequestTypeDef]
     ) -> AdminGetUserResponseTypeDef:
         """
-        Gets the specified user by user name in a user pool as an administrator.
+        Given the username, returns details about a user profile in a user pool.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/admin_get_user.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#admin_get_user)
@@ -458,7 +458,8 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[AdminInitiateAuthRequestRequestTypeDef]
     ) -> AdminInitiateAuthResponseTypeDef:
         """
-        Initiates the authentication flow, as an administrator.
+        Starts sign-in for applications with a server-side component, for example a
+        traditional web application.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/admin_initiate_auth.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#admin_initiate_auth)
@@ -500,8 +501,8 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[AdminListUserAuthEventsRequestRequestTypeDef]
     ) -> AdminListUserAuthEventsResponseTypeDef:
         """
-        A history of user activity and any risks detected as part of Amazon Cognito
-        advanced security.
+        Requests a history of user activity and any risks detected as part of Amazon
+        Cognito threat protection.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/admin_list_user_auth_events.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#admin_list_user_auth_events)
@@ -511,7 +512,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[AdminRemoveUserFromGroupRequestRequestTypeDef]
     ) -> EmptyResponseMetadataTypeDef:
         """
-        Removes the specified user from the specified group.
+        Given a username and a group name.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/admin_remove_user_from_group.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#admin_remove_user_from_group)
@@ -521,7 +522,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[AdminResetUserPasswordRequestRequestTypeDef]
     ) -> Dict[str, Any]:
         """
-        Resets the specified user's password in a user pool as an administrator.
+        Resets the specified user's password in a user pool.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/admin_reset_user_password.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#admin_reset_user_password)
@@ -554,7 +555,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[AdminSetUserPasswordRequestRequestTypeDef]
     ) -> Dict[str, Any]:
         """
-        Sets the specified user's password in a user pool as an administrator.
+        Sets the specified user's password in a user pool.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/admin_set_user_password.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#admin_set_user_password)
@@ -586,7 +587,8 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[AdminUpdateDeviceStatusRequestRequestTypeDef]
     ) -> Dict[str, Any]:
         """
-        Updates the device status as an administrator.
+        Updates the status of a user's device so that it is marked as remembered or not
+        remembered for the purpose of device authentication.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/admin_update_device_status.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#admin_update_device_status)
@@ -649,7 +651,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[ConfirmDeviceRequestRequestTypeDef]
     ) -> ConfirmDeviceResponseTypeDef:
         """
-        Confirms tracking of the device.
+        Confirms a device that a user wants to remember.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/confirm_device.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#confirm_device)
@@ -659,7 +661,8 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[ConfirmForgotPasswordRequestRequestTypeDef]
     ) -> Dict[str, Any]:
         """
-        Allows a user to enter a confirmation code to reset a forgotten password.
+        This public API operation accepts a confirmation code that Amazon Cognito sent
+        to a user and accepts a new password for that user.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/confirm_forgot_password.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#confirm_forgot_password)
@@ -669,7 +672,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[ConfirmSignUpRequestRequestTypeDef]
     ) -> ConfirmSignUpResponseTypeDef:
         """
-        This public API operation provides a code that Amazon Cognito sent to your user
+        This public API operation submits a code that Amazon Cognito sent to your user
         when they signed up in your user pool via the <a
         href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SignUp.html">SignUp</a>
         API operation.
@@ -744,7 +747,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[CreateUserPoolClientRequestRequestTypeDef]
     ) -> CreateUserPoolClientResponseTypeDef:
         """
-        Creates the user pool client.
+        Creates an app client in a user pool.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/create_user_pool_client.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#create_user_pool_client)
@@ -754,7 +757,8 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[CreateUserPoolDomainRequestRequestTypeDef]
     ) -> CreateUserPoolDomainResponseTypeDef:
         """
-        Creates a new domain for a user pool.
+        A user pool domain hosts managed login, an authorization server and web server
+        for authentication in your application.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/create_user_pool_domain.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#create_user_pool_domain)
@@ -764,7 +768,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[DeleteGroupRequestRequestTypeDef]
     ) -> EmptyResponseMetadataTypeDef:
         """
-        Deletes a group.
+        Deletes a group from the specified user pool.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/delete_group.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#delete_group)
@@ -774,7 +778,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[DeleteIdentityProviderRequestRequestTypeDef]
     ) -> EmptyResponseMetadataTypeDef:
         """
-        Deletes an IdP for a user pool.
+        Deletes a user pool identity provider (IdP).
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/delete_identity_provider.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#delete_identity_provider)
@@ -804,7 +808,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[DeleteUserRequestRequestTypeDef]
     ) -> EmptyResponseMetadataTypeDef:
         """
-        Allows a user to delete their own user profile.
+        Self-deletes a user profile.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/delete_user.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#delete_user)
@@ -814,7 +818,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[DeleteUserAttributesRequestRequestTypeDef]
     ) -> Dict[str, Any]:
         """
-        Deletes the attributes for a user.
+        Self-deletes attributes for a user.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/delete_user_attributes.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#delete_user_attributes)
@@ -824,7 +828,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[DeleteUserPoolRequestRequestTypeDef]
     ) -> EmptyResponseMetadataTypeDef:
         """
-        Deletes the specified Amazon Cognito user pool.
+        Deletes a user pool.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/delete_user_pool.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#delete_user_pool)
@@ -834,7 +838,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[DeleteUserPoolClientRequestRequestTypeDef]
     ) -> EmptyResponseMetadataTypeDef:
         """
-        Allows the developer to delete the user pool client.
+        Deletes a user pool app client.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/delete_user_pool_client.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#delete_user_pool_client)
@@ -844,7 +848,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[DeleteUserPoolDomainRequestRequestTypeDef]
     ) -> Dict[str, Any]:
         """
-        Deletes a domain for a user pool.
+        Given a user pool ID and domain identifier, deletes a user pool domain.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/delete_user_pool_domain.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#delete_user_pool_domain)
@@ -854,8 +858,8 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[DeleteWebAuthnCredentialRequestRequestTypeDef]
     ) -> Dict[str, Any]:
         """
-        Deletes a registered passkey, or webauthN, device for the currently signed-in
-        user.
+        Deletes a registered passkey, or webauthN, authenticator for the currently
+        signed-in user.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/delete_web_authn_credential.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#delete_web_authn_credential)
@@ -865,7 +869,8 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[DescribeIdentityProviderRequestRequestTypeDef]
     ) -> DescribeIdentityProviderResponseTypeDef:
         """
-        Gets information about a specific IdP.
+        Given a user pool ID and identity provider (IdP) name, returns details about
+        the IdP.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/describe_identity_provider.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#describe_identity_provider)
@@ -875,8 +880,8 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[DescribeManagedLoginBrandingRequestRequestTypeDef]
     ) -> DescribeManagedLoginBrandingResponseTypeDef:
         """
-        When given the ID of a managed login branding style, returns detailed
-        information about the style.
+        Given the ID of a managed login branding style, returns detailed information
+        about the style.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/describe_managed_login_branding.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#describe_managed_login_branding)
@@ -886,8 +891,8 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[DescribeManagedLoginBrandingByClientRequestRequestTypeDef]
     ) -> DescribeManagedLoginBrandingByClientResponseTypeDef:
         """
-        When given the ID of a user pool app client, returns detailed information about
-        the style assigned to the app client.
+        Given the ID of a user pool app client, returns detailed information about the
+        style assigned to the app client.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/describe_managed_login_branding_by_client.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#describe_managed_login_branding_by_client)
@@ -907,7 +912,8 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[DescribeRiskConfigurationRequestRequestTypeDef]
     ) -> DescribeRiskConfigurationResponseTypeDef:
         """
-        Describes the risk configuration.
+        Given an app client or user pool ID where threat protection is configured,
+        describes the risk configuration.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/describe_risk_configuration.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#describe_risk_configuration)
@@ -917,7 +923,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[DescribeUserImportJobRequestRequestTypeDef]
     ) -> DescribeUserImportJobResponseTypeDef:
         """
-        Describes the user import job.
+        Describes a user import job.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/describe_user_import_job.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#describe_user_import_job)
@@ -927,7 +933,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[DescribeUserPoolRequestRequestTypeDef]
     ) -> DescribeUserPoolResponseTypeDef:
         """
-        Returns the configuration information and metadata of the specified user pool.
+        Given a user pool ID, returns configuration information.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/describe_user_pool.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#describe_user_pool)
@@ -937,8 +943,7 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[DescribeUserPoolClientRequestRequestTypeDef]
     ) -> DescribeUserPoolClientResponseTypeDef:
         """
-        Client method for returning the configuration information and metadata of the
-        specified user pool app client.
+        Given an app client ID, returns configuration information.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/describe_user_pool_client.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#describe_user_pool_client)
@@ -948,7 +953,8 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[DescribeUserPoolDomainRequestRequestTypeDef]
     ) -> DescribeUserPoolDomainResponseTypeDef:
         """
-        Gets information about a domain.
+        Given a user pool domain name, returns information about the domain
+        configuration.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/describe_user_pool_domain.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#describe_user_pool_domain)
@@ -1465,8 +1471,8 @@ class CognitoIdentityProviderClient(BaseClient):
         self, **kwargs: Unpack[UpdateUserPoolDomainRequestRequestTypeDef]
     ) -> UpdateUserPoolDomainResponseTypeDef:
         """
-        Updates the Secure Sockets Layer (SSL) certificate for the custom domain for
-        your user pool.
+        A user pool domain hosts managed login, an authorization server and web server
+        for authentication in your application.
 
         [Show boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/update_user_pool_domain.html)
         [Show types-boto3-full documentation](https://youtype.github.io/types_boto3_docs/types_boto3_cognito_idp/client/#update_user_pool_domain)