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

Class: Aws::CognitoIdentityProvider::Types::AdminDeleteUserAttributesRequest

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 AdminDeleteUserAttributesRequest data as a hash:

{
  user_pool_id: "UserPoolIdType", # required
  username: "UsernameType", # required
  user_attribute_names: ["AttributeNameType"], # required
}

Represents the request to delete user attributes as an administrator.

Instance Attribute Summary collapse

Instance Attribute Details

#user_attribute_namesArray<String>

An array of strings representing the user attribute names you wish to delete.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Returns:

  • (Array<String>)


358
359
360
361
362
363
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 358

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

#user_pool_idString

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

Returns:

  • (String)


358
359
360
361
362
363
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 358

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

#usernameString

The user name of the user from which you would like to delete attributes.

Returns:

  • (String)


358
359
360
361
362
363
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 358

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