Struct aws_sdk_ivs::client::fluent_builders::PutMetadata

pub struct PutMetadata<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to PutMetadata.

Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.

Implementations

impl<C, M, R> PutMetadata<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(self) -> Result<PutMetadataOutput, SdkError<PutMetadataError>> where
    R::Policy: SmithyRetryPolicy<PutMetadataInputOperationOutputAlias, PutMetadataOutput, PutMetadataError, PutMetadataInputOperationRetryAlias>, 

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_arn(self, inp: impl Into<String>) -> Self

ARN of the channel into which metadata is inserted. This channel must have an active stream.

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

ARN of the channel into which metadata is inserted. This channel must have an active stream.

pub fn metadata(self, inp: impl Into<String>) -> Self

Metadata to insert into the stream. Maximum: 1 KB per request.

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

Metadata to insert into the stream. Maximum: 1 KB per request.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for PutMetadata<C, M, R>

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

Formats the value using the given formatter.