Struct aws_sdk_iot::client::fluent_builders::CreateCustomMetric

pub struct CreateCustomMetric { /* private fields */ }

Fluent builder constructing a request to CreateCustomMetric.

Use this API to define a Custom Metric published by your devices to Device Defender.

Requires permission to access the CreateCustomMetric action.

Implementations

impl CreateCustomMetric

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateCustomMetric, AwsResponseRetryClassifier>, SdkError<CreateCustomMetricError>>

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<CreateCustomMetricOutput, SdkError<CreateCustomMetricError>>

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

The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with aws:. You can't change the name after you define it.

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

The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with aws:. You can't change the name after you define it.

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

The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.

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

The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.

pub fn metric_type(self, input: CustomMetricType) -> Self

The type of the custom metric.

The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.

pub fn set_metric_type(self, input: Option<CustomMetricType>) -> Self

The type of the custom metric.

The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

Metadata that can be used to manage the custom metric.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

Metadata that can be used to manage the custom metric.

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

Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

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

Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

Trait Implementations

impl Clone for CreateCustomMetric

fn clone(&self) -> CreateCustomMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCustomMetric

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

Formats the value using the given formatter.