Struct aws_sdk_iot::client::fluent_builders::CreateCustomMetric

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

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<C, M, R> CreateCustomMetric<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateCustomMetricOutput, SdkError<CreateCustomMetricError>> where
    R::Policy: SmithyRetryPolicy<CreateCustomMetricInputOperationOutputAlias, CreateCustomMetricOutput, CreateCustomMetricError, CreateCustomMetricInputOperationRetryAlias>, 

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

The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws:. Cannot be updated once defined.

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. Shouldn't begin with aws:. Cannot be updated once defined.

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

Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.

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

Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.

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

The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

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

The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

pub fn tags(self, inp: impl Into<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, inp: 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<C: Debug, M: Debug, R: Debug> Debug for CreateCustomMetric<C, M, R>

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

Formats the value using the given formatter.