Class: Aws::Chime::Types::UpdateChannelRequest

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

{
  channel_arn: "ChimeArn", # required
  name: "NonEmptyResourceName", # required
  mode: "UNRESTRICTED", # required, accepts UNRESTRICTED, RESTRICTED
  metadata: "Metadata",
  chime_bearer: "ChimeArn",
}

Constant Summary collapse

SENSITIVE =
[:name, :metadata]

Instance Attribute Summary collapse

Instance Attribute Details

#channel_arnString

The ARN of the channel.

Returns:

  • (String)


10265
10266
10267
10268
10269
10270
10271
10272
10273
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 10265

class UpdateChannelRequest < Struct.new(
  :channel_arn,
  :name,
  :mode,
  :metadata,
  :chime_bearer)
  SENSITIVE = [:name, :metadata]
  include Aws::Structure
end

#chime_bearerString

The AppInstanceUserArn of the user that makes the API call.

Returns:

  • (String)


10265
10266
10267
10268
10269
10270
10271
10272
10273
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 10265

class UpdateChannelRequest < Struct.new(
  :channel_arn,
  :name,
  :mode,
  :metadata,
  :chime_bearer)
  SENSITIVE = [:name, :metadata]
  include Aws::Structure
end

#metadataString

The metadata for the update request.

Returns:

  • (String)


10265
10266
10267
10268
10269
10270
10271
10272
10273
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 10265

class UpdateChannelRequest < Struct.new(
  :channel_arn,
  :name,
  :mode,
  :metadata,
  :chime_bearer)
  SENSITIVE = [:name, :metadata]
  include Aws::Structure
end

#modeString

The mode of the update request.

Returns:

  • (String)


10265
10266
10267
10268
10269
10270
10271
10272
10273
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 10265

class UpdateChannelRequest < Struct.new(
  :channel_arn,
  :name,
  :mode,
  :metadata,
  :chime_bearer)
  SENSITIVE = [:name, :metadata]
  include Aws::Structure
end

#nameString

The name of the channel.

Returns:

  • (String)


10265
10266
10267
10268
10269
10270
10271
10272
10273
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 10265

class UpdateChannelRequest < Struct.new(
  :channel_arn,
  :name,
  :mode,
  :metadata,
  :chime_bearer)
  SENSITIVE = [:name, :metadata]
  include Aws::Structure
end