Class: Aws::Chime::Types::CreateChannelMembershipRequest

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

Overview

Note:

When making an API call, you may pass CreateChannelMembershipRequest data as a hash:

{
  channel_arn: "ChimeArn", # required
  member_arn: "ChimeArn", # required
  type: "DEFAULT", # required, accepts DEFAULT, HIDDEN
  chime_bearer: "ChimeArn",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#channel_arnString

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

Returns:

  • (String)


2109
2110
2111
2112
2113
2114
2115
2116
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2109

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

#chime_bearerString

The AppInstanceUserArn of the user that makes the API call.

Returns:

  • (String)


2109
2110
2111
2112
2113
2114
2115
2116
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2109

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

#member_arnString

The ARN of the member you want to add to the channel.

Returns:

  • (String)


2109
2110
2111
2112
2113
2114
2115
2116
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2109

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

#typeString

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)


2109
2110
2111
2112
2113
2114
2115
2116
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2109

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