Class: Aws::ChimeSDKMessaging::Types::CreateChannelMembershipRequest

Inherits:

Struct

• Object
• Struct
• Aws::ChimeSDKMessaging::Types::CreateChannelMembershipRequest

Includes:

Structure

Defined in:

lib/aws-sdk-chimesdkmessaging/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #channel_arn ⇒ String

  The ARN of the channel to which you’re adding users.

• #chime_bearer ⇒ String

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

• #member_arn ⇒ String

  The ‘AppInstanceUserArn` of the member you want to add to the channel.

• #sub_channel_id ⇒ String

  The ID of the SubChannel in the request.

• #type ⇒ String

  The membership type of a user, ‘DEFAULT` or `HIDDEN`.

Instance Attribute Details

#channel_arn ⇒ String

The ARN of the channel to which you’re adding users.

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 1091

class CreateChannelMembershipRequest < Struct.new(
  :channel_arn,
  :member_arn,
  :type,
  :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)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 1091

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

#member_arn ⇒ String

The ‘AppInstanceUserArn` of the member you want to add to the channel.

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 1091

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

#sub_channel_id ⇒ String

The ID of the SubChannel in the request.

<note markdown=“1”> Only required when creating membership in a SubChannel for a moderator in an elastic channel.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 1091

class CreateChannelMembershipRequest < Struct.new(
  :channel_arn,
  :member_arn,
  :type,
  :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)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 1091

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