Class: Aws::Chime::Types::SendChannelMessageRequest

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

{
  channel_arn: "ChimeArn", # required
  content: "NonEmptyContent", # required
  type: "STANDARD", # required, accepts STANDARD, CONTROL
  persistence: "PERSISTENT", # required, accepts PERSISTENT, NON_PERSISTENT
  metadata: "Metadata",
  client_request_token: "ClientRequestToken", # required
  chime_bearer: "ChimeArn",
}

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Attribute Details

#channel_arnString

The ARN of the channel.

Returns:

  • (String)


9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 9073

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

#chime_bearerString

The AppInstanceUserArn of the user that makes the API call.

Returns:

  • (String)


9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 9073

class SendChannelMessageRequest < Struct.new(
  :channel_arn,
  :content,
  :type,
  :persistence,
  :metadata,
  :client_request_token,
  :chime_bearer)
  SENSITIVE = [:content, :metadata, :client_request_token]
  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)


9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 9073

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

#contentString

The content of the message.

Returns:

  • (String)


9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 9073

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

#metadataString

The optional metadata for each message.

Returns:

  • (String)


9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 9073

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

#persistenceString

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

Returns:

  • (String)


9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 9073

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

#typeString

The type of message, STANDARD or CONTROL.

Returns:

  • (String)


9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 9073

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