Struct aws_sdk_iotsitewise::operation::create_asset_model::CreateAssetModelInput

#[non_exhaustive]
pub struct CreateAssetModelInput {
    pub asset_model_name: Option<String>,
    pub asset_model_description: Option<String>,
    pub asset_model_properties: Option<Vec<AssetModelPropertyDefinition>>,
    pub asset_model_hierarchies: Option<Vec<AssetModelHierarchyDefinition>>,
    pub asset_model_composite_models: Option<Vec<AssetModelCompositeModelDefinition>>,
    pub client_token: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub asset_model_id: Option<String>,
    pub asset_model_external_id: Option<String>,
    pub asset_model_type: Option<AssetModelType>,
}

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.

asset_model_name: Option<String>

A unique, friendly name for the asset model.

asset_model_description: Option<String>

A description for the asset model.

asset_model_properties: Option<Vec<AssetModelPropertyDefinition>>

The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

asset_model_hierarchies: Option<Vec<AssetModelHierarchyDefinition>>

The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

asset_model_composite_models: Option<Vec<AssetModelCompositeModelDefinition>>

The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see .

client_token: Option<String>

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

tags: Option<HashMap<String, String>>

A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

asset_model_id: Option<String>

The ID to assign to the asset model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

asset_model_external_id: Option<String>

An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

asset_model_type: Option<AssetModelType>

The type of asset model.

• ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

• COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

Implementations

impl CreateAssetModelInput

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

A unique, friendly name for the asset model.

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

A description for the asset model.

pub fn asset_model_properties(&self) -> &[AssetModelPropertyDefinition]

The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

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

pub fn asset_model_hierarchies(&self) -> &[AssetModelHierarchyDefinition]

The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

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

pub fn asset_model_composite_models( &self ) -> &[AssetModelCompositeModelDefinition]

The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see .

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

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

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

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

A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

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

The ID to assign to the asset model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

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

An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

pub fn asset_model_type(&self) -> Option<&AssetModelType>

The type of asset model.

• ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

• COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

impl CreateAssetModelInput

pub fn builder() -> CreateAssetModelInputBuilder

Creates a new builder-style object to manufacture CreateAssetModelInput.

Trait Implementations

impl Clone for CreateAssetModelInput

fn clone(&self) -> CreateAssetModelInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateAssetModelInput

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

Formats the value using the given formatter.

impl PartialEq for CreateAssetModelInput

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