Amazon AppStream 2.0
API Reference (API Version 2016-12-01)

DisableUser

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.

Request Syntax

{ "AuthenticationType": "string", "UserName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AuthenticationType

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

Type: String

Valid Values: API | SAML | USERPOOL

Required: Yes

UserName

The email address of the user.

Note

Users' email addresses are case-sensitive.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: