You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::AdminDeleteUserRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass AdminDeleteUserRequest data as a hash:

{
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
}

Represents the request to delete a user as an administrator.

Instance Attribute Summary collapse

Instance Attribute Details

#user_pool_idString

The user pool ID for the user pool where you want to delete the user.

Returns:

  • (String)


533
534
535
536
537
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 533

class AdminDeleteUserRequest < Struct.new(
  :user_pool_id,
  :username)
  include Aws::Structure
end

#usernameString

The user name of the user you wish to delete.

Returns:

  • (String)


533
534
535
536
537
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 533

class AdminDeleteUserRequest < Struct.new(
  :user_pool_id,
  :username)
  include Aws::Structure
end