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

Class: Aws::CognitoIdentityProvider::Types::AdminRemoveUserFromGroupRequest

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#group_nameString

The group name.

Returns:

  • (String)


1034
1035
1036
1037
1038
1039
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1034

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

#user_pool_idString

The user pool ID for the user pool.

Returns:

  • (String)


1034
1035
1036
1037
1038
1039
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1034

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

#usernameString

The username for the user.

Returns:

  • (String)


1034
1035
1036
1037
1038
1039
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1034

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