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

Inherits:

Struct

• Object
• Struct
• Aws::Chime::Types::UpdateChannelRequest

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",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:name, :metadata]

Instance Attribute Summary

• #channel_arn ⇒ String

  The ARN of the channel.

• #chime_bearer ⇒ String

  The AppInstanceUserArn of the user that makes the API call.

• #metadata ⇒ String

  The metadata for the update request.

• #mode ⇒ String

  The mode of the update request.

• #name ⇒ String

  The name of the channel.

Instance Attribute Details

#channel_arn ⇒ String

The ARN of the channel.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 10258

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

#chime_bearer ⇒ String

The AppInstanceUserArn of the user that makes the API call.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 10258

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

#metadata ⇒ String

The metadata for the update request.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 10258

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

#mode ⇒ String

The mode of the update request.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 10258

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

#name ⇒ String

The name of the channel.

Returns:

• (String)

# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 10258

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