Class: Aws::Wickr::Types::BatchToggleUserSuspendStatusRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

A unique identifier for this request to ensure idempotency.

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

Returns:

  • (String)


462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 462

class BatchToggleUserSuspendStatusRequest < Struct.new(
  :network_id,
  :suspend,
  :user_ids,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#network_idString

The ID of the Wickr network where users will be suspended or unsuspended.

Returns:

  • (String)


462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 462

class BatchToggleUserSuspendStatusRequest < Struct.new(
  :network_id,
  :suspend,
  :user_ids,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#suspendBoolean

A boolean value indicating whether to suspend (true) or unsuspend (false) the specified users.

Returns:

  • (Boolean)


462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 462

class BatchToggleUserSuspendStatusRequest < Struct.new(
  :network_id,
  :suspend,
  :user_ids,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#user_idsArray<String>

A list of user IDs identifying the users whose suspend status will be toggled. Maximum 50 users per batch request.

Returns:

  • (Array<String>)


462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-wickr/lib/aws-sdk-wickr/types.rb', line 462

class BatchToggleUserSuspendStatusRequest < Struct.new(
  :network_id,
  :suspend,
  :user_ids,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end