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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-chimesdkmessaging/types.rb

Overview

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Attribute Details

#channel_arnString

The ARN of the channel.

Returns:

  • (String)


3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
# 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_bearerString

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

Returns:

  • (String)


3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
# 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_tokenString

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)


3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
# 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

#contentString

The content of the channel message.

Returns:

  • (String)


3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
# 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_typeString

The content type of the channel message.

Returns:

  • (String)


3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
# 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_attributesHash<String,Types::MessageAttributeValue>

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

Returns:



3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
# 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

#metadataString

The optional metadata for each message.

Returns:

  • (String)


3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
# 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

#persistenceString

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

Returns:

  • (String)


3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
# 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_notificationTypes::PushNotificationConfiguration

The push notification configuration of the message.



3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
# 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_idString

The ID of the SubChannel in the request.

Returns:

  • (String)


3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
# 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

#targetArray<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:



3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
# 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

#typeString

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)


3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
# 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