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

Class: Aws::CognitoIdentityProvider::Types::DeleteUserAttributesRequest

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

{
  user_attribute_names: ["AttributeNameType"], # required
  access_token: "TokenModelType", # required
}

Represents the request to delete user attributes.

Instance Attribute Summary collapse

Instance Attribute Details

#access_tokenString

The access token used in the request to delete user attributes.

Returns:

  • (String)


3026
3027
3028
3029
3030
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3026

class DeleteUserAttributesRequest < Struct.new(
  :user_attribute_names,
  :access_token)
  include Aws::Structure
end

#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>)


3026
3027
3028
3029
3030
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 3026

class DeleteUserAttributesRequest < Struct.new(
  :user_attribute_names,
  :access_token)
  include Aws::Structure
end