Class: Aws::ChimeSDKMessaging::Types::BatchCreateChannelMembershipRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#channel_arn ⇒ String

The ARN of the channel to which you're adding users or bots.

Returns:

  • (String) 


171
172
173
174
175
176
177
178
179
 
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 171

class BatchCreateChannelMembershipRequest < Struct.new(
  :channel_arn,
  :type,
  :member_arns,
  :chime_bearer,
  :sub_channel_id)
  SENSITIVE = []
  include Aws::Structure
end

#chime_bearer ⇒ String

The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Returns:

  • (String) 


171
172
173
174
175
176
177
178
179
 
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 171

class BatchCreateChannelMembershipRequest < Struct.new(
  :channel_arn,
  :type,
  :member_arns,
  :chime_bearer,
  :sub_channel_id)
  SENSITIVE = []
  include Aws::Structure
end

#member_arns ⇒ Array<String>

The ARNs of the members you want to add to the channel. Only AppInstanceUsers and AppInstanceBots can be added as a channel member.

Returns:

  • (Array<String>) 


171
172
173
174
175
176
177
178
179
 
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 171

class BatchCreateChannelMembershipRequest < Struct.new(
  :channel_arn,
  :type,
  :member_arns,
  :chime_bearer,
  :sub_channel_id)
  SENSITIVE = []
  include Aws::Structure
end

#sub_channel_id ⇒ String

The ID of the SubChannel in the request.

Only required when creating membership in a SubChannel for a moderator in an elastic channel.

Returns:

  • (String) 


171
172
173
174
175
176
177
178
179
 
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 171

class BatchCreateChannelMembershipRequest < Struct.new(
  :channel_arn,
  :type,
  :member_arns,
  :chime_bearer,
  :sub_channel_id)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.

Returns:

  • (String) 


171
172
173
174
175
176
177
178
179
 
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 171

class BatchCreateChannelMembershipRequest < Struct.new(
  :channel_arn,
  :type,
  :member_arns,
  :chime_bearer,
  :sub_channel_id)
  SENSITIVE = []
  include Aws::Structure
end