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

display_name: Option<String>

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.

metric_type: Option<CustomMetricType>

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

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 async fn make_operation(
    self,
    _config: &Config
) -> Result<Operation<CreateCustomMetric, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<CreateCustomMetric>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateCustomMetricInput

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

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

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

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

pub fn tags(&self) -> Option<&[Tag]>

Metadata that can be used to manage the custom metric.

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.

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<CreateCustomMetricInput> 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: &CreateCustomMetricInput) -> bool

This method tests for !=.

impl StructuralPartialEq for CreateCustomMetricInput