Class: Aws::ChimeSDKMessaging::Types::SendChannelMessageRequest

Inherits:

Struct

• Object
• Struct
• Aws::ChimeSDKMessaging::Types::SendChannelMessageRequest

Includes:

Structure

Defined in:

lib/aws-sdk-chimesdkmessaging/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:content, :metadata, :client_request_token, :message_attributes, :content_type]

Instance Attribute Summary

• #channel_arn ⇒ String

  The ARN of the channel.

• #chime_bearer ⇒ String

  The ARN of the ‘AppInstanceUser` or `AppInstanceBot` that makes the API call.

• #client_request_token ⇒ String

  The ‘Idempotency` token for each client request.

• #content ⇒ String

  The content of the channel message.

• #content_type ⇒ String

  The content type of the channel message.

• #message_attributes ⇒ Hash<String,Types::MessageAttributeValue>

  The attributes for the message, used for message filtering along with a ‘FilterRule` defined in the `PushNotificationPreferences`.

• #metadata ⇒ String

  The optional metadata for each message.

• #persistence ⇒ String

  Boolean that controls whether the message is persisted on the back end.

• #push_notification ⇒ Types::PushNotificationConfiguration

  The push notification configuration of the message.

• #sub_channel_id ⇒ String

  The ID of the SubChannel in the request.

• #target ⇒ Array<Types::Target>

  The target of a message.

• #type ⇒ String

  The type of message, ‘STANDARD` or `CONTROL`.

Instance Attribute Details

#channel_arn ⇒ String

The ARN of the channel.

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 3007

class SendChannelMessageRequest < Struct.new(
  :channel_arn,
  :content,
  :type,
  :persistence,
  :metadata,
  :client_request_token,
  :chime_bearer,
  :push_notification,
  :message_attributes,
  :sub_channel_id,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :client_request_token, :message_attributes, :content_type]
  include Aws::Structure
end

#chime_bearer ⇒ String

The ARN of the ‘AppInstanceUser` or `AppInstanceBot` that makes the API call.

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 3007

class SendChannelMessageRequest < Struct.new(
  :channel_arn,
  :content,
  :type,
  :persistence,
  :metadata,
  :client_request_token,
  :chime_bearer,
  :push_notification,
  :message_attributes,
  :sub_channel_id,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :client_request_token, :message_attributes, :content_type]
  include Aws::Structure
end

#client_request_token ⇒ String

The ‘Idempotency` token for each client request.

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

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 3007

class SendChannelMessageRequest < Struct.new(
  :channel_arn,
  :content,
  :type,
  :persistence,
  :metadata,
  :client_request_token,
  :chime_bearer,
  :push_notification,
  :message_attributes,
  :sub_channel_id,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :client_request_token, :message_attributes, :content_type]
  include Aws::Structure
end

#content ⇒ String

The content of the channel message.

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 3007

class SendChannelMessageRequest < Struct.new(
  :channel_arn,
  :content,
  :type,
  :persistence,
  :metadata,
  :client_request_token,
  :chime_bearer,
  :push_notification,
  :message_attributes,
  :sub_channel_id,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :client_request_token, :message_attributes, :content_type]
  include Aws::Structure
end

#content_type ⇒ String

The content type of the channel message.

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 3007

class SendChannelMessageRequest < Struct.new(
  :channel_arn,
  :content,
  :type,
  :persistence,
  :metadata,
  :client_request_token,
  :chime_bearer,
  :push_notification,
  :message_attributes,
  :sub_channel_id,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :client_request_token, :message_attributes, :content_type]
  include Aws::Structure
end

#message_attributes ⇒ Hash<String,Types::MessageAttributeValue>

The attributes for the message, used for message filtering along with a ‘FilterRule` defined in the `PushNotificationPreferences`.

Returns:

• (Hash<String,Types::MessageAttributeValue>)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 3007

class SendChannelMessageRequest < Struct.new(
  :channel_arn,
  :content,
  :type,
  :persistence,
  :metadata,
  :client_request_token,
  :chime_bearer,
  :push_notification,
  :message_attributes,
  :sub_channel_id,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :client_request_token, :message_attributes, :content_type]
  include Aws::Structure
end

#metadata ⇒ String

The optional metadata for each message.

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 3007

class SendChannelMessageRequest < Struct.new(
  :channel_arn,
  :content,
  :type,
  :persistence,
  :metadata,
  :client_request_token,
  :chime_bearer,
  :push_notification,
  :message_attributes,
  :sub_channel_id,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :client_request_token, :message_attributes, :content_type]
  include Aws::Structure
end

#persistence ⇒ String

Boolean that controls whether the message is persisted on the back end. Required.

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 3007

class SendChannelMessageRequest < Struct.new(
  :channel_arn,
  :content,
  :type,
  :persistence,
  :metadata,
  :client_request_token,
  :chime_bearer,
  :push_notification,
  :message_attributes,
  :sub_channel_id,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :client_request_token, :message_attributes, :content_type]
  include Aws::Structure
end

#push_notification ⇒ Types::PushNotificationConfiguration

The push notification configuration of the message.

Returns:

• (Types::PushNotificationConfiguration)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 3007

class SendChannelMessageRequest < Struct.new(
  :channel_arn,
  :content,
  :type,
  :persistence,
  :metadata,
  :client_request_token,
  :chime_bearer,
  :push_notification,
  :message_attributes,
  :sub_channel_id,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :client_request_token, :message_attributes, :content_type]
  include Aws::Structure
end

#sub_channel_id ⇒ String

The ID of the SubChannel in the request.

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 3007

class SendChannelMessageRequest < Struct.new(
  :channel_arn,
  :content,
  :type,
  :persistence,
  :metadata,
  :client_request_token,
  :chime_bearer,
  :push_notification,
  :message_attributes,
  :sub_channel_id,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :client_request_token, :message_attributes, :content_type]
  include Aws::Structure
end

#target ⇒ Array<Types::Target>

The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

Returns:

• (Array<Types::Target>)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 3007

class SendChannelMessageRequest < Struct.new(
  :channel_arn,
  :content,
  :type,
  :persistence,
  :metadata,
  :client_request_token,
  :chime_bearer,
  :push_notification,
  :message_attributes,
  :sub_channel_id,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :client_request_token, :message_attributes, :content_type]
  include Aws::Structure
end

#type ⇒ String

The type of message, ‘STANDARD` or `CONTROL`.

‘STANDARD` messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.

‘CONTROL` messages are limited to 30 bytes and do not contain metadata.

Returns:

• (String)

# File 'lib/aws-sdk-chimesdkmessaging/types.rb', line 3007

class SendChannelMessageRequest < Struct.new(
  :channel_arn,
  :content,
  :type,
  :persistence,
  :metadata,
  :client_request_token,
  :chime_bearer,
  :push_notification,
  :message_attributes,
  :sub_channel_id,
  :content_type,
  :target)
  SENSITIVE = [:content, :metadata, :client_request_token, :message_attributes, :content_type]
  include Aws::Structure
end