Class: Aws::Chime::Types::BatchCreateChannelMembershipRequest

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 BatchCreateChannelMembershipRequest data as a hash:

{
  channel_arn: "ChimeArn", # required
  type: "DEFAULT", # accepts DEFAULT, HIDDEN
  member_arns: ["ChimeArn"], # required
  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)


740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 740

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

#chime_bearerString

The AppInstanceUserArn of the user that makes the API call.

Returns:

  • (String)


740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 740

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

#member_arnsArray<String>

The ARNs of the members you want to add to the channel.

Returns:

  • (Array<String>)


740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 740

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


740
741
742
743
744
745
746
747
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 740

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