Struct aws_sdk_iot::operation::create_custom_metric::CreateCustomMetricInput

#[non_exhaustive]
pub struct CreateCustomMetricInput {
    pub metric_name: Option<String>,
    pub display_name: Option<String>,
    pub metric_type: Option<CustomMetricType>,
    pub tags: Option<Vec<Tag>>,
    pub client_request_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

metric_name: Option<String>

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.

display_name: Option<String>

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.

metric_type: Option<CustomMetricType>

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.

tags: Option<Vec<Tag>>

Metadata that can be used to manage the custom metric.

client_request_token: Option<String>

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.

Implementations

impl CreateCustomMetricInput

pub fn metric_name(&self) -> Option<&str>

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) -> Option<&str>

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) -> Option<&CustomMetricType>

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) -> &[Tag]

Metadata that can be used to manage the custom metric.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn client_request_token(&self) -> Option<&str>

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.

impl CreateCustomMetricInput

pub fn builder() -> CreateCustomMetricInputBuilder

Creates a new builder-style object to manufacture CreateCustomMetricInput.

Trait Implementations

impl Clone for CreateCustomMetricInput

fn clone(&self) -> CreateCustomMetricInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCustomMetricInput

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

Formats the value using the given formatter.

impl PartialEq for CreateCustomMetricInput

fn eq(&self, other: &CreateCustomMetricInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateCustomMetricInput