Class: Aws::Chime::Types::CreateChannelRequest

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

{
  app_instance_arn: "ChimeArn", # required
  name: "NonEmptyResourceName", # required
  mode: "UNRESTRICTED", # accepts UNRESTRICTED, RESTRICTED
  privacy: "PUBLIC", # accepts PUBLIC, PRIVATE
  metadata: "Metadata",
  client_request_token: "ClientRequestToken", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  chime_bearer: "ChimeArn",
}

Constant Summary collapse

SENSITIVE =
[:name, :metadata, :client_request_token]

Instance Attribute Summary collapse

Instance Attribute Details

#app_instance_arnString

The ARN of the channel request.

Returns:

  • (String)


2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2244

class CreateChannelRequest < Struct.new(
  :app_instance_arn,
  :name,
  :mode,
  :privacy,
  :metadata,
  :client_request_token,
  :tags,
  :chime_bearer)
  SENSITIVE = [:name, :metadata, :client_request_token]
  include Aws::Structure
end

#chime_bearerString

The AppInstanceUserArn of the user that makes the API call.

Returns:

  • (String)


2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2244

class CreateChannelRequest < Struct.new(
  :app_instance_arn,
  :name,
  :mode,
  :privacy,
  :metadata,
  :client_request_token,
  :tags,
  :chime_bearer)
  SENSITIVE = [:name, :metadata, :client_request_token]
  include Aws::Structure
end

#client_request_tokenString

The client token for the request. An Idempotency token.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2244

class CreateChannelRequest < Struct.new(
  :app_instance_arn,
  :name,
  :mode,
  :privacy,
  :metadata,
  :client_request_token,
  :tags,
  :chime_bearer)
  SENSITIVE = [:name, :metadata, :client_request_token]
  include Aws::Structure
end

#metadataString

The metadata of the creation request. Limited to 1KB and UTF-8.

Returns:

  • (String)


2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2244

class CreateChannelRequest < Struct.new(
  :app_instance_arn,
  :name,
  :mode,
  :privacy,
  :metadata,
  :client_request_token,
  :tags,
  :chime_bearer)
  SENSITIVE = [:name, :metadata, :client_request_token]
  include Aws::Structure
end

#modeString

The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

Returns:

  • (String)


2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2244

class CreateChannelRequest < Struct.new(
  :app_instance_arn,
  :name,
  :mode,
  :privacy,
  :metadata,
  :client_request_token,
  :tags,
  :chime_bearer)
  SENSITIVE = [:name, :metadata, :client_request_token]
  include Aws::Structure
end

#nameString

The name of the channel.

Returns:

  • (String)


2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2244

class CreateChannelRequest < Struct.new(
  :app_instance_arn,
  :name,
  :mode,
  :privacy,
  :metadata,
  :client_request_token,
  :tags,
  :chime_bearer)
  SENSITIVE = [:name, :metadata, :client_request_token]
  include Aws::Structure
end

#privacyString

The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.

Returns:

  • (String)


2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2244

class CreateChannelRequest < Struct.new(
  :app_instance_arn,
  :name,
  :mode,
  :privacy,
  :metadata,
  :client_request_token,
  :tags,
  :chime_bearer)
  SENSITIVE = [:name, :metadata, :client_request_token]
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tags for the creation request.

Returns:



2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2244

class CreateChannelRequest < Struct.new(
  :app_instance_arn,
  :name,
  :mode,
  :privacy,
  :metadata,
  :client_request_token,
  :tags,
  :chime_bearer)
  SENSITIVE = [:name, :metadata, :client_request_token]
  include Aws::Structure
end