Skip to content

AdminUpdateDeviceStatusRequest

Source code in docs_src/capo_cognito_identity_provider/types/admin_update_device_status_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class AdminUpdateDeviceStatusRequest(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 change a user's device status.</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>"""
    device_key: "capo_cognito_identity_provider.types.device_key_type.DeviceKeyType"
    """<p>The unique identifier, or device key, of the device that you want to update the status for.</p>"""
    device_remembered_status: NotRequired[
        "capo_cognito_identity_provider.types.device_remembered_status_type.DeviceRememberedStatusType"
    ]
    """<p>To enable device authentication with the specified device, set to <code>remembered</code>.To disable, set to <code>not_remembered</code>.</p>"""

device_key instance-attribute 

device_key: DeviceKeyType

The unique identifier, or device key, of the device that you want to update the status for.

device_remembered_status instance-attribute 

device_remembered_status: NotRequired[DeviceRememberedStatusType]

To enable device authentication with the specified device, set to remembered.To disable, set to not_remembered.

user_pool_id instance-attribute 

user_pool_id: UserPoolIdType

The ID of the user pool where you want to change a user's device status.

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.