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

Class: Aws::CognitoIdentityProvider::Types::AdminDisableProviderForUserRequest

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

{
  user_pool_id: "StringType", # required
  user: { # required
    provider_name: "ProviderNameType",
    provider_attribute_name: "StringType",
    provider_attribute_value: "StringType",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#userTypes::ProviderUserIdentifierType

The user to be disabled.



421
422
423
424
425
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 421

class AdminDisableProviderForUserRequest < Struct.new(
  :user_pool_id,
  :user)
  include Aws::Structure
end

#user_pool_idString

The user pool ID for the user pool.

Returns:

  • (String)


421
422
423
424
425
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 421

class AdminDisableProviderForUserRequest < Struct.new(
  :user_pool_id,
  :user)
  include Aws::Structure
end