Skip to content

AdminDeleteUserAttributesRequest

Source code in docs_src/capo_cognito_identity_provider/types/admin_delete_user_attributes_request.py 
15
16
17
18
19
20
21
22
23
class AdminDeleteUserAttributesRequest(TypedDict, closed=True):
    user_pool_id: (
        "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType"
    )
    """<p>The ID of the user pool where you want to delete user attributes.</p>"""
    username: "capo_cognito_identity_provider.types.username_type.UsernameType"
    """<p>The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If <code>username</code> isn't an alias attribute in your user pool, this value must be the <code>sub</code> of a local user or the username of a user from a third-party IdP.</p>"""
    user_attribute_names: "capo_cognito_identity_provider.types.attribute_name_list_type.AttributeNameListType"
    """<p>An array of strings representing the user attribute names you want to delete.</p> <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>"""

user_attribute_names instance-attribute 

user_attribute_names: AttributeNameListType

An array of strings representing the user attribute names you want to delete.

For custom attributes, you must prepend the custom: prefix to the attribute name.

user_pool_id instance-attribute 

user_pool_id: UserPoolIdType

The ID of the user pool where you want to delete user attributes.

username instance-attribute 

username: UsernameType

The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.