admin_update_device_status ¶

def admin_update_device_status(
    self,
    user_pool_id: "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType",
    username: "capo_cognito_identity_provider.types.username_type.UsernameType",
    device_key: "capo_cognito_identity_provider.types.device_key_type.DeviceKeyType",
    *,
    config_overrides: Optional[CognitoIdentityProviderClientConfig] = None,
    device_remembered_status: Optional[
        "capo_cognito_identity_provider.types.device_remembered_status_type.DeviceRememberedStatusType"
    ] = None,
) -> "capo_cognito_identity_provider.types.admin_update_device_status_response.AdminUpdateDeviceStatusResponse":
    """<p>Updates the status of a user's device so that it is marked as remembered or not remembered for the purpose of device authentication. Device authentication is a "remember me" mechanism that silently completes sign-in from trusted devices with a device key instead of a user-provided MFA code. This operation changes the status of a device without deleting it, so you can enable it again later. For more information about device authentication, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html">Working with devices</a>.</p> <note> <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.</p> <p class="title"> <b>Learn more</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a> </p> </li> </ul> </note>

    Args:
        user_pool_id: <p>The ID of the user pool where you want to change a user's device status.</p>
        username: <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: <p>The unique identifier, or device key, of the device that you want to update the status for.</p>
        device_remembered_status: <p>To enable device authentication with the specified device, set to <code>remembered</code>.To disable, set to <code>not_remembered</code>.</p>

    Raises:
        capo_cognito_identity_provider.errors.internal_error_exception.InternalErrorException: <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
        capo_cognito_identity_provider.errors.invalid_parameter_exception.InvalidParameterException: <p>This exception is thrown when the Amazon Cognito service encounters an invalid parameter.</p>
        capo_cognito_identity_provider.errors.invalid_user_pool_configuration_exception.InvalidUserPoolConfigurationException: <p>This exception is thrown when the user pool configuration is not valid.</p>
        capo_cognito_identity_provider.errors.not_authorized_exception.NotAuthorizedException: <p>This exception is thrown when a user isn't authorized.</p>
        capo_cognito_identity_provider.errors.operation_not_enabled_exception.OperationNotEnabledException: <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</p>
        capo_cognito_identity_provider.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when the Amazon Cognito service can't find the requested resource.</p>
        capo_cognito_identity_provider.errors.too_many_requests_exception.TooManyRequestsException: <p>This exception is thrown when the user has made too many requests for a given operation.</p>
        capo_cognito_identity_provider.errors.user_not_found_exception.UserNotFoundException: <p>This exception is thrown when a user isn't found.</p>
        capo_cognito_identity_provider.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cognito_identity_provider.types.admin_update_device_status_request.AdminUpdateDeviceStatusRequest]",
    ) -> OperationResponse[
        "capo_cognito_identity_provider.types.admin_update_device_status_response.AdminUpdateDeviceStatusResponse"
    ]:
        import capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.admin_update_device_status

        output, http_response = (
            capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.admin_update_device_status.admin_update_device_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_cognito_identity_provider.types.admin_update_device_status_request.AdminUpdateDeviceStatusRequest",
    ) -> dict[str, Any]:
        import capo_cognito_identity_provider.types.admin_update_device_status_request

        return capo_cognito_identity_provider.types.admin_update_device_status_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("AdminUpdateDeviceStatus", redact_input=_redact_input),
    )
    input_: capo_cognito_identity_provider.types.admin_update_device_status_request.AdminUpdateDeviceStatusRequest = {
        "user_pool_id": user_pool_id,
        "username": username,
        "device_key": device_key,
    }
    if device_remembered_status is not None:
        input_["device_remembered_status"] = device_remembered_status

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output