Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

disable_user

disable_user(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.disable_user(
    UserName='string',
    AuthenticationType='API'|'SAML'|'USERPOOL'|'AWS_AD'
)
Parameters
  • UserName (string) --

    [REQUIRED]

    The email address of the user.

    Note

    Users' email addresses are case-sensitive.

  • AuthenticationType (string) --

    [REQUIRED]

    The authentication type for the user. You must specify USERPOOL.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • AppStream.Client.exceptions.ResourceNotFoundException