Struct aws_sdk_iot::operation::describe_thing::DescribeThingOutput

#[non_exhaustive]
pub struct DescribeThingOutput {
    pub default_client_id: Option<String>,
    pub thing_name: Option<String>,
    pub thing_id: Option<String>,
    pub thing_arn: Option<String>,
    pub thing_type_name: Option<String>,
    pub attributes: Option<HashMap<String, String>>,
    pub version: i64,
    pub billing_group_name: Option<String>,
    /* private fields */
}

The output from the DescribeThing operation.

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.

default_client_id: Option<String>

The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

thing_name: Option<String>

The name of the thing.

thing_id: Option<String>

The ID of the thing to describe.

thing_arn: Option<String>

The ARN of the thing to describe.

thing_type_name: Option<String>

The thing type name.

attributes: Option<HashMap<String, String>>

The thing attributes.

version: i64

The current version of the thing record in the registry.

To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.

billing_group_name: Option<String>

The name of the billing group the thing belongs to.

Implementations

impl DescribeThingOutput

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

The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

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

The name of the thing.

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

The ID of the thing to describe.

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

The ARN of the thing to describe.

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

The thing type name.

pub fn attributes(&self) -> Option<&HashMap<String, String>>

The thing attributes.

pub fn version(&self) -> i64

The current version of the thing record in the registry.

To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.

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

The name of the billing group the thing belongs to.

impl DescribeThingOutput

pub fn builder() -> DescribeThingOutputBuilder

Creates a new builder-style object to manufacture DescribeThingOutput.

Trait Implementations

impl Clone for DescribeThingOutput

fn clone(&self) -> DescribeThingOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeThingOutput

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

Formats the value using the given formatter.

impl PartialEq for DescribeThingOutput

fn eq(&self, other: &DescribeThingOutput) -> 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 RequestId for DescribeThingOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeThingOutput