Skip to content

Disables the specified user in the user pool

Description

Disables the specified user in the user pool. Users can't sign in to WorkSpaces Applications until they are re-enabled. This action does not delete the user.

Usage

appstream_disable_user(UserName, AuthenticationType)

Arguments

  • UserName

    [required] The email address of the user.

    Users' email addresses are case-sensitive.

  • AuthenticationType

    [required] The authentication type for the user. You must specify USERPOOL.

Value

An empty list.

Request syntax

svc$disable_user(
  UserName = "string",
  AuthenticationType = "API"|"SAML"|"USERPOOL"|"AWS_AD"
)