Struct aws_sdk_iotanalytics::client::fluent_builders::BatchPutMessage

pub struct BatchPutMessage { /* private fields */ }

Fluent builder constructing a request to BatchPutMessage.

Sends messages to a channel.

Implementations

impl BatchPutMessage

pub async fn customize(
    self
) -> Result<CustomizableOperation<BatchPutMessage, AwsResponseRetryClassifier>, SdkError<BatchPutMessageError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<BatchPutMessageOutput, SdkError<BatchPutMessageError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn channel_name(self, input: impl Into<String>) -> Self

The name of the channel where the messages are sent.

pub fn set_channel_name(self, input: Option<String>) -> Self

The name of the channel where the messages are sent.

pub fn messages(self, input: Message) -> Self

Appends an item to messages.

To override the contents of this collection use set_messages.

The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.

The field names of message payloads (data) that you send to IoT Analytics:

• Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.

• Must begin with an alphabetic character or single underscore (_).

• Cannot contain hyphens (-).

• In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".

• Cannot be more than 255 characters.

• Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

pub fn set_messages(self, input: Option<Vec<Message>>) -> Self

The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.

The field names of message payloads (data) that you send to IoT Analytics:

• Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.

• Must begin with an alphabetic character or single underscore (_).

• Cannot contain hyphens (-).

• In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".

• Cannot be more than 255 characters.

• Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

Trait Implementations

impl Clone for BatchPutMessage

fn clone(&self) -> BatchPutMessage

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BatchPutMessage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.