Class: Aws::DirectoryServiceData::Types::DisableUserRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-directoryservicedata/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.

A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.

If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an ‘ConflictException`.

<note markdown=“1”> This parameter is optional when using the CLI or SDK.

</note>

**A suitable default value is auto-generated.** You should normally not need to pass this option.



732
733
734
735
736
737
738
 
# File 'lib/aws-sdk-directoryservicedata/types.rb', line 732

class DisableUserRequest < Struct.new(
  :client_token,
  :directory_id,
  :sam_account_name)
  SENSITIVE = []
  include Aws::Structure
end

#directory_id ⇒ String

The identifier (ID) of the directory that’s associated with the user.



732
733
734
735
736
737
738
 
# File 'lib/aws-sdk-directoryservicedata/types.rb', line 732

class DisableUserRequest < Struct.new(
  :client_token,
  :directory_id,
  :sam_account_name)
  SENSITIVE = []
  include Aws::Structure
end

#sam_account_name ⇒ String

The name of the user.



732
733
734
735
736
737
738
 
# File 'lib/aws-sdk-directoryservicedata/types.rb', line 732

class DisableUserRequest < Struct.new(
  :client_token,
  :directory_id,
  :sam_account_name)
  SENSITIVE = []
  include Aws::Structure
end