Struct aws_sdk_iotsitewise::Client

pub struct Client { /* private fields */ }

Client for AWS IoT SiteWise

Client for invoking operations on AWS IoT SiteWise. Each operation on AWS IoT SiteWise is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_iotsitewise::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_iotsitewise::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AssociateAssets operation has a Client::associate_assets, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.associate_assets()
    .asset_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations

impl Client

pub fn associate_assets(&self) -> AssociateAssetsFluentBuilder

Constructs a fluent builder for the AssociateAssets operation.

• The fluent builder is configurable:
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: true
    

    The ID of the parent asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • hierarchy_id(impl Into<String>) / set_hierarchy_id(Option<String>):
    required: true
    

    The ID of a hierarchy in the parent asset’s model. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

    
    
  • child_asset_id(impl Into<String>) / set_child_asset_id(Option<String>):
    required: true
    

    The ID of the child asset to be associated. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with AssociateAssetsOutput
• On failure, responds with SdkError<AssociateAssetsError>

impl Client

pub fn associate_time_series_to_asset_property( &self ) -> AssociateTimeSeriesToAssetPropertyFluentBuilder

Constructs a fluent builder for the AssociateTimeSeriesToAssetProperty operation.

• The fluent builder is configurable:
  • alias(impl Into<String>) / set_alias(Option<String>):
    required: true
    

    The alias that identifies the time series.

    
    
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: true
    

    The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • property_id(impl Into<String>) / set_property_id(Option<String>):
    required: true
    

    The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with AssociateTimeSeriesToAssetPropertyOutput
• On failure, responds with SdkError<AssociateTimeSeriesToAssetPropertyError>

impl Client

pub fn batch_associate_project_assets( &self ) -> BatchAssociateProjectAssetsFluentBuilder

Constructs a fluent builder for the BatchAssociateProjectAssets operation.

• The fluent builder is configurable:
  • project_id(impl Into<String>) / set_project_id(Option<String>):
    required: true
    

    The ID of the project to which to associate the assets.

    
    
  • asset_ids(impl Into<String>) / set_asset_ids(Option<Vec::<String>>):
    required: true
    

    The IDs of the assets to be associated to the project.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with BatchAssociateProjectAssetsOutput with field(s):
  • errors(Option<Vec::<AssetErrorDetails>>):

    A list of associated error information, if any.

• On failure, responds with SdkError<BatchAssociateProjectAssetsError>

impl Client

pub fn batch_disassociate_project_assets( &self ) -> BatchDisassociateProjectAssetsFluentBuilder

Constructs a fluent builder for the BatchDisassociateProjectAssets operation.

• The fluent builder is configurable:
  • project_id(impl Into<String>) / set_project_id(Option<String>):
    required: true
    

    The ID of the project from which to disassociate the assets.

    
    
  • asset_ids(impl Into<String>) / set_asset_ids(Option<Vec::<String>>):
    required: true
    

    The IDs of the assets to be disassociated from the project.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with BatchDisassociateProjectAssetsOutput with field(s):
  • errors(Option<Vec::<AssetErrorDetails>>):

    A list of associated error information, if any.

• On failure, responds with SdkError<BatchDisassociateProjectAssetsError>

impl Client

pub fn batch_get_asset_property_aggregates( &self ) -> BatchGetAssetPropertyAggregatesFluentBuilder

Constructs a fluent builder for the BatchGetAssetPropertyAggregates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • entries(BatchGetAssetPropertyAggregatesEntry) / set_entries(Option<Vec::<BatchGetAssetPropertyAggregatesEntry>>):
    required: true
    

    The list of asset property aggregate entries for the batch get request. You can specify up to 16 entries per request.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

    • The size of the result set is equal to 1 MB.

    • The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 4000.

    
    
• On success, responds with BatchGetAssetPropertyAggregatesOutput with field(s):
  • error_entries(Vec::<BatchGetAssetPropertyAggregatesErrorEntry>):

    A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.

  • success_entries(Vec::<BatchGetAssetPropertyAggregatesSuccessEntry>):

    A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.

  • skipped_entries(Vec::<BatchGetAssetPropertyAggregatesSkippedEntry>):

    A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<BatchGetAssetPropertyAggregatesError>

impl Client

pub fn batch_get_asset_property_value( &self ) -> BatchGetAssetPropertyValueFluentBuilder

Constructs a fluent builder for the BatchGetAssetPropertyValue operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • entries(BatchGetAssetPropertyValueEntry) / set_entries(Option<Vec::<BatchGetAssetPropertyValueEntry>>):
    required: true
    

    The list of asset property value entries for the batch get request. You can specify up to 128 entries per request.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
• On success, responds with BatchGetAssetPropertyValueOutput with field(s):
  • error_entries(Vec::<BatchGetAssetPropertyValueErrorEntry>):

    A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.

  • success_entries(Vec::<BatchGetAssetPropertyValueSuccessEntry>):

    A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.

  • skipped_entries(Vec::<BatchGetAssetPropertyValueSkippedEntry>):

    A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<BatchGetAssetPropertyValueError>

impl Client

pub fn batch_get_asset_property_value_history( &self ) -> BatchGetAssetPropertyValueHistoryFluentBuilder

Constructs a fluent builder for the BatchGetAssetPropertyValueHistory operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • entries(BatchGetAssetPropertyValueHistoryEntry) / set_entries(Option<Vec::<BatchGetAssetPropertyValueHistoryEntry>>):
    required: true
    

    The list of asset property historical value entries for the batch get request. You can specify up to 16 entries per request.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

    • The size of the result set is equal to 4 MB.

    • The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 20000.

    
    
• On success, responds with BatchGetAssetPropertyValueHistoryOutput with field(s):
  • error_entries(Vec::<BatchGetAssetPropertyValueHistoryErrorEntry>):

    A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.

  • success_entries(Vec::<BatchGetAssetPropertyValueHistorySuccessEntry>):

    A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.

  • skipped_entries(Vec::<BatchGetAssetPropertyValueHistorySkippedEntry>):

    A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<BatchGetAssetPropertyValueHistoryError>

impl Client

pub fn batch_put_asset_property_value( &self ) -> BatchPutAssetPropertyValueFluentBuilder

Constructs a fluent builder for the BatchPutAssetPropertyValue operation.

• The fluent builder is configurable:
  • entries(PutAssetPropertyValueEntry) / set_entries(Option<Vec::<PutAssetPropertyValueEntry>>):
    required: true
    

    The list of asset property value entries for the batch put request. You can specify up to 10 entries per request.

    
    
• On success, responds with BatchPutAssetPropertyValueOutput with field(s):
  • error_entries(Vec::<BatchPutAssetPropertyErrorEntry>):

    A list of the errors (if any) associated with the batch put request. Each error entry contains the entryId of the entry that failed.

• On failure, responds with SdkError<BatchPutAssetPropertyValueError>

impl Client

pub fn create_access_policy(&self) -> CreateAccessPolicyFluentBuilder

Constructs a fluent builder for the CreateAccessPolicy operation.

• The fluent builder is configurable:
  • access_policy_identity(Identity) / set_access_policy_identity(Option<Identity>):
    required: true
    

    The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.

    
    
  • access_policy_resource(Resource) / set_access_policy_resource(Option<Resource>):
    required: true
    

    The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.

    
    
  • access_policy_permission(Permission) / set_access_policy_permission(Option<Permission>):
    required: true
    

    The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

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

    
    
• On success, responds with CreateAccessPolicyOutput with field(s):
  • access_policy_id(String):

    The ID of the access policy.

  • access_policy_arn(String):

    The ARN of the access policy, which has the following format.

    arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}

• On failure, responds with SdkError<CreateAccessPolicyError>

impl Client

pub fn create_asset(&self) -> CreateAssetFluentBuilder

Constructs a fluent builder for the CreateAsset operation.

• The fluent builder is configurable:
  • asset_name(impl Into<String>) / set_asset_name(Option<String>):
    required: true
    

    A friendly name for the asset.

    
    
  • asset_model_id(impl Into<String>) / set_asset_model_id(Option<String>):
    required: true
    

    The ID of the asset model from which to create the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

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

    
    
  • asset_description(impl Into<String>) / set_asset_description(Option<String>):
    required: false
    

    A description for the asset.

    
    
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: false
    

    The ID to assign to the asset, 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_external_id(impl Into<String>) / set_asset_external_id(Option<String>):
    required: false
    

    An external ID to assign to the asset. 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.

    
    
• On success, responds with CreateAssetOutput with field(s):
  • asset_id(String):

    The ID of the asset, in UUID format. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise API operations.

  • asset_arn(String):

    The ARN of the asset, which has the following format.

    arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

  • asset_status(Option<AssetStatus>):

    The status of the asset, which contains a state (CREATING after successfully calling this operation) and any error message.

• On failure, responds with SdkError<CreateAssetError>

impl Client

pub fn create_asset_model(&self) -> CreateAssetModelFluentBuilder

Constructs a fluent builder for the CreateAssetModel operation.

• The fluent builder is configurable:
  • asset_model_name(impl Into<String>) / set_asset_model_name(Option<String>):
    required: true
    

    A unique, friendly name for the asset model.

    
    
  • asset_model_description(impl Into<String>) / set_asset_model_description(Option<String>):
    required: false
    

    A description for the asset model.

    
    
  • asset_model_properties(AssetModelPropertyDefinition) / set_asset_model_properties(Option<Vec::<AssetModelPropertyDefinition>>):
    required: false
    

    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(AssetModelHierarchyDefinition) / set_asset_model_hierarchies(Option<Vec::<AssetModelHierarchyDefinition>>):
    required: false
    

    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(AssetModelCompositeModelDefinition) / set_asset_model_composite_models(Option<Vec::<AssetModelCompositeModelDefinition>>):
    required: false
    

    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(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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(impl Into<String>) / set_asset_model_id(Option<String>):
    required: false
    

    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(impl Into<String>) / set_asset_model_external_id(Option<String>):
    required: false
    

    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(AssetModelType) / set_asset_model_type(Option<AssetModelType>):
    required: false
    

    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.

    
    
• On success, responds with CreateAssetModelOutput with field(s):
  • asset_model_id(String):

    The ID of the asset model, in UUID format. You can use this ID when you call other IoT SiteWise API operations.

  • asset_model_arn(String):

    The ARN of the asset model, which has the following format.

    arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

  • asset_model_status(Option<AssetModelStatus>):

    The status of the asset model, which contains a state (CREATING after successfully calling this operation) and any error message.

• On failure, responds with SdkError<CreateAssetModelError>

impl Client

pub fn create_asset_model_composite_model( &self ) -> CreateAssetModelCompositeModelFluentBuilder

Constructs a fluent builder for the CreateAssetModelCompositeModel operation.

• The fluent builder is configurable:
  • asset_model_id(impl Into<String>) / set_asset_model_id(Option<String>):
    required: true
    

    The ID of the asset model this composite model is a part of.

    
    
  • parent_asset_model_composite_model_id(impl Into<String>) / set_parent_asset_model_composite_model_id(Option<String>):
    required: false
    

    The ID of the parent composite model in this asset model relationship.

    
    
  • asset_model_composite_model_external_id(impl Into<String>) / set_asset_model_composite_model_external_id(Option<String>):
    required: false
    

    An external ID to assign to the composite model.

    If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it’s a part of.

    
    
  • asset_model_composite_model_id(impl Into<String>) / set_asset_model_composite_model_id(Option<String>):
    required: false
    

    The ID of the composite model. 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_composite_model_description(impl Into<String>) / set_asset_model_composite_model_description(Option<String>):
    required: false
    

    A description for the composite model.

    
    
  • asset_model_composite_model_name(impl Into<String>) / set_asset_model_composite_model_name(Option<String>):
    required: true
    

    A unique, friendly name for the composite model.

    
    
  • asset_model_composite_model_type(impl Into<String>) / set_asset_model_composite_model_type(Option<String>):
    required: true
    

    The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
  • composed_asset_model_id(impl Into<String>) / set_composed_asset_model_id(Option<String>):
    required: false
    

    The ID of a composite model on this asset.

    
    
  • asset_model_composite_model_properties(AssetModelPropertyDefinition) / set_asset_model_composite_model_properties(Option<Vec::<AssetModelPropertyDefinition>>):
    required: false
    

    The property definitions of the composite model. For more information, see .

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

    
    
• On success, responds with CreateAssetModelCompositeModelOutput with field(s):
  • asset_model_composite_model_id(String):

    The ID of the composed asset model. You can use this ID when you call other IoT SiteWise APIs.

  • asset_model_composite_model_path(Vec::<AssetModelCompositeModelPathSegment>):

    The path to the composite model listing the parent composite models.

  • asset_model_status(Option<AssetModelStatus>):

    Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide.

• On failure, responds with SdkError<CreateAssetModelCompositeModelError>

impl Client

pub fn create_bulk_import_job(&self) -> CreateBulkImportJobFluentBuilder

Constructs a fluent builder for the CreateBulkImportJob operation.

• The fluent builder is configurable:
  • job_name(impl Into<String>) / set_job_name(Option<String>):
    required: true
    

    The unique name that helps identify the job request.

    
    
  • job_role_arn(impl Into<String>) / set_job_role_arn(Option<String>):
    required: true
    

    The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.

    
    
  • files(File) / set_files(Option<Vec::<File>>):
    required: true
    

    The files in the specified Amazon S3 bucket that contain your data.

    
    
  • error_report_location(ErrorReportLocation) / set_error_report_location(Option<ErrorReportLocation>):
    required: true
    

    The Amazon S3 destination where errors associated with the job creation request are saved.

    
    
  • job_configuration(JobConfiguration) / set_job_configuration(Option<JobConfiguration>):
    required: true
    

    Contains the configuration information of a job, such as the file format used to save data in Amazon S3.

    
    
  • adaptive_ingestion(bool) / set_adaptive_ingestion(Option<bool>):
    required: false
    

    If set to true, ingest new data into IoT SiteWise storage. Measurements with notifications, metrics and transforms are computed. If set to false, historical data is ingested into IoT SiteWise as is.

    
    
  • delete_files_after_import(bool) / set_delete_files_after_import(Option<bool>):
    required: false
    

    If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.

    
    
• On success, responds with CreateBulkImportJobOutput with field(s):
  • job_id(String):

    The ID of the job.

  • job_name(String):

    The unique name that helps identify the job request.

  • job_status(JobStatus):

    The status of the bulk import job can be one of following values:

    • PENDING – IoT SiteWise is waiting for the current bulk import job to finish.

    • CANCELLED – The bulk import job has been canceled.

    • RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.

    • COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.

    • FAILED – IoT SiteWise couldn’t process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

    • COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

• On failure, responds with SdkError<CreateBulkImportJobError>

impl Client

pub fn create_dashboard(&self) -> CreateDashboardFluentBuilder

Constructs a fluent builder for the CreateDashboard operation.

• The fluent builder is configurable:
  • project_id(impl Into<String>) / set_project_id(Option<String>):
    required: true
    

    The ID of the project in which to create the dashboard.

    
    
  • dashboard_name(impl Into<String>) / set_dashboard_name(Option<String>):
    required: true
    

    A friendly name for the dashboard.

    
    
  • dashboard_description(impl Into<String>) / set_dashboard_description(Option<String>):
    required: false
    

    A description for the dashboard.

    
    
  • dashboard_definition(impl Into<String>) / set_dashboard_definition(Option<String>):
    required: true
    

    The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

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

    
    
• On success, responds with CreateDashboardOutput with field(s):
  • dashboard_id(String):

    The ID of the dashboard.

  • dashboard_arn(String):

    The ARN of the dashboard, which has the following format.

    arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}

• On failure, responds with SdkError<CreateDashboardError>

impl Client

pub fn create_gateway(&self) -> CreateGatewayFluentBuilder

Constructs a fluent builder for the CreateGateway operation.

• The fluent builder is configurable:
  • gateway_name(impl Into<String>) / set_gateway_name(Option<String>):
    required: true
    

    A unique, friendly name for the gateway.

    
    
  • gateway_platform(GatewayPlatform) / set_gateway_platform(Option<GatewayPlatform>):
    required: true
    

    The gateway’s platform. You can only specify one platform in a gateway.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

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

    
    
• On success, responds with CreateGatewayOutput with field(s):
  • gateway_id(String):

    The ID of the gateway device. You can use this ID when you call other IoT SiteWise API operations.

  • gateway_arn(String):

    The ARN of the gateway, which has the following format.

    arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}

• On failure, responds with SdkError<CreateGatewayError>

impl Client

pub fn create_portal(&self) -> CreatePortalFluentBuilder

Constructs a fluent builder for the CreatePortal operation.

• The fluent builder is configurable:
  • portal_name(impl Into<String>) / set_portal_name(Option<String>):
    required: true
    

    A friendly name for the portal.

    
    
  • portal_description(impl Into<String>) / set_portal_description(Option<String>):
    required: false
    

    A description for the portal.

    
    
  • portal_contact_email(impl Into<String>) / set_portal_contact_email(Option<String>):
    required: true
    

    The Amazon Web Services administrator’s contact email address.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
  • portal_logo_image_file(ImageFile) / set_portal_logo_image_file(Option<ImageFile>):
    required: false
    

    A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The ARN of a service role that allows the portal’s users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

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

    
    
  • portal_auth_mode(AuthMode) / set_portal_auth_mode(Option<AuthMode>):
    required: false
    

    The service to use to authenticate users to the portal. Choose from the following options:

    • SSO – The portal uses IAM Identity Center to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see Enabling IAM Identity Center in the IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions.

    • IAM – The portal uses Identity and Access Management to authenticate users and manage user permissions.

    You can’t change this value after you create a portal.

    Default: SSO

    
    
  • notification_sender_email(impl Into<String>) / set_notification_sender_email(Option<String>):
    required: false
    

    The email address that sends alarm notifications.

    If you use the IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES.

    
    
  • alarms(Alarms) / set_alarms(Option<Alarms>):
    required: false
    

    Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.

    
    
• On success, responds with CreatePortalOutput with field(s):
  • portal_id(String):

    The ID of the created portal.

  • portal_arn(String):

    The ARN of the portal, which has the following format.

    arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

  • portal_start_url(String):

    The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.

  • portal_status(Option<PortalStatus>):

    The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.

  • sso_application_id(String):

    The associated IAM Identity Center application ID, if the portal uses IAM Identity Center.

• On failure, responds with SdkError<CreatePortalError>

impl Client

pub fn create_project(&self) -> CreateProjectFluentBuilder

Constructs a fluent builder for the CreateProject operation.

• The fluent builder is configurable:
  • portal_id(impl Into<String>) / set_portal_id(Option<String>):
    required: true
    

    The ID of the portal in which to create the project.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    A friendly name for the project.

    
    
  • project_description(impl Into<String>) / set_project_description(Option<String>):
    required: false
    

    A description for the project.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

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

    
    
• On success, responds with CreateProjectOutput with field(s):
  • project_id(String):

    The ID of the project.

  • project_arn(String):

    The ARN of the project, which has the following format.

    arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}

• On failure, responds with SdkError<CreateProjectError>

impl Client

pub fn delete_access_policy(&self) -> DeleteAccessPolicyFluentBuilder

Constructs a fluent builder for the DeleteAccessPolicy operation.

• The fluent builder is configurable:
  • access_policy_id(impl Into<String>) / set_access_policy_id(Option<String>):
    required: true
    

    The ID of the access policy to be deleted.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DeleteAccessPolicyOutput
• On failure, responds with SdkError<DeleteAccessPolicyError>

impl Client

pub fn delete_asset(&self) -> DeleteAssetFluentBuilder

Constructs a fluent builder for the DeleteAsset operation.

• The fluent builder is configurable:
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: true
    

    The ID of the asset to delete. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DeleteAssetOutput with field(s):
  • asset_status(Option<AssetStatus>):

    The status of the asset, which contains a state (DELETING after successfully calling this operation) and any error message.

• On failure, responds with SdkError<DeleteAssetError>

impl Client

pub fn delete_asset_model(&self) -> DeleteAssetModelFluentBuilder

Constructs a fluent builder for the DeleteAssetModel operation.

• The fluent builder is configurable:
  • asset_model_id(impl Into<String>) / set_asset_model_id(Option<String>):
    required: true
    

    The ID of the asset model to delete. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DeleteAssetModelOutput with field(s):
  • asset_model_status(Option<AssetModelStatus>):

    The status of the asset model, which contains a state (DELETING after successfully calling this operation) and any error message.

• On failure, responds with SdkError<DeleteAssetModelError>

impl Client

pub fn delete_asset_model_composite_model( &self ) -> DeleteAssetModelCompositeModelFluentBuilder

Constructs a fluent builder for the DeleteAssetModelCompositeModel operation.

• The fluent builder is configurable:
  • asset_model_id(impl Into<String>) / set_asset_model_id(Option<String>):
    required: true
    

    The ID of the asset model, in UUID format.

    
    
  • asset_model_composite_model_id(impl Into<String>) / set_asset_model_composite_model_id(Option<String>):
    required: true
    

    The ID of a composite model on this asset model.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DeleteAssetModelCompositeModelOutput with field(s):
  • asset_model_status(Option<AssetModelStatus>):

    Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide.

• On failure, responds with SdkError<DeleteAssetModelCompositeModelError>

impl Client

pub fn delete_dashboard(&self) -> DeleteDashboardFluentBuilder

Constructs a fluent builder for the DeleteDashboard operation.

• The fluent builder is configurable:
  • dashboard_id(impl Into<String>) / set_dashboard_id(Option<String>):
    required: true
    

    The ID of the dashboard to delete.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DeleteDashboardOutput
• On failure, responds with SdkError<DeleteDashboardError>

impl Client

pub fn delete_gateway(&self) -> DeleteGatewayFluentBuilder

Constructs a fluent builder for the DeleteGateway operation.

• The fluent builder is configurable:
  • gateway_id(impl Into<String>) / set_gateway_id(Option<String>):
    required: true
    

    The ID of the gateway to delete.

    
    
• On success, responds with DeleteGatewayOutput
• On failure, responds with SdkError<DeleteGatewayError>

impl Client

pub fn delete_portal(&self) -> DeletePortalFluentBuilder

Constructs a fluent builder for the DeletePortal operation.

• The fluent builder is configurable:
  • portal_id(impl Into<String>) / set_portal_id(Option<String>):
    required: true
    

    The ID of the portal to delete.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DeletePortalOutput with field(s):
  • portal_status(Option<PortalStatus>):

    The status of the portal, which contains a state (DELETING after successfully calling this operation) and any error message.

• On failure, responds with SdkError<DeletePortalError>

impl Client

pub fn delete_project(&self) -> DeleteProjectFluentBuilder

Constructs a fluent builder for the DeleteProject operation.

• The fluent builder is configurable:
  • project_id(impl Into<String>) / set_project_id(Option<String>):
    required: true
    

    The ID of the project.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DeleteProjectOutput
• On failure, responds with SdkError<DeleteProjectError>

impl Client

pub fn delete_time_series(&self) -> DeleteTimeSeriesFluentBuilder

Constructs a fluent builder for the DeleteTimeSeries operation.

• The fluent builder is configurable:
  • alias(impl Into<String>) / set_alias(Option<String>):
    required: false
    

    The alias that identifies the time series.

    
    
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: false
    

    The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • property_id(impl Into<String>) / set_property_id(Option<String>):
    required: false
    

    The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DeleteTimeSeriesOutput
• On failure, responds with SdkError<DeleteTimeSeriesError>

impl Client

pub fn describe_access_policy(&self) -> DescribeAccessPolicyFluentBuilder

Constructs a fluent builder for the DescribeAccessPolicy operation.

• The fluent builder is configurable:
  • access_policy_id(impl Into<String>) / set_access_policy_id(Option<String>):
    required: true
    

    The ID of the access policy.

    
    
• On success, responds with DescribeAccessPolicyOutput with field(s):
  • access_policy_id(String):

    The ID of the access policy.

  • access_policy_arn(String):

    The ARN of the access policy, which has the following format.

    arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}

  • access_policy_identity(Option<Identity>):

    The identity (IAM Identity Center user, IAM Identity Center group, or IAM user) to which this access policy applies.

  • access_policy_resource(Option<Resource>):

    The IoT SiteWise Monitor resource (portal or project) to which this access policy provides access.

  • access_policy_permission(Permission):

    The access policy permission. Note that a project ADMINISTRATOR is also known as a project owner.

  • access_policy_creation_date(DateTime):

    The date the access policy was created, in Unix epoch time.

  • access_policy_last_update_date(DateTime):

    The date the access policy was last updated, in Unix epoch time.

• On failure, responds with SdkError<DescribeAccessPolicyError>

impl Client

pub fn describe_action(&self) -> DescribeActionFluentBuilder

Constructs a fluent builder for the DescribeAction operation.

• The fluent builder is configurable:
  • action_id(impl Into<String>) / set_action_id(Option<String>):
    required: true
    

    The ID of the action.

    
    
• On success, responds with DescribeActionOutput with field(s):
  • action_id(String):

    The ID of the action.

  • target_resource(Option<TargetResource>):

    The resource the action will be taken on.

  • action_definition_id(String):

    The ID of the action definition.

  • action_payload(Option<ActionPayload>):

    The JSON payload of the action.

  • execution_time(DateTime):

    The time the action was executed.

• On failure, responds with SdkError<DescribeActionError>

impl Client

pub fn describe_asset(&self) -> DescribeAssetFluentBuilder

Constructs a fluent builder for the DescribeAsset operation.

• The fluent builder is configurable:
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: true
    

    The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • exclude_properties(bool) / set_exclude_properties(Option<bool>):
    required: false
    

    Whether or not to exclude asset properties from the response.

    
    
• On success, responds with DescribeAssetOutput with field(s):
  • asset_id(String):

    The ID of the asset, in UUID format.

  • asset_arn(String):

    The ARN of the asset, which has the following format.

    arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

  • asset_name(String):

    The name of the asset.

  • asset_model_id(String):

    The ID of the asset model that was used to create the asset.

  • asset_properties(Vec::<AssetProperty>):

    The list of asset properties for the asset.

    This object doesn’t include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

  • asset_hierarchies(Vec::<AssetHierarchy>):

    A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

  • asset_composite_models(Option<Vec::<AssetCompositeModel>>):

    The composite models for the asset.

  • asset_creation_date(DateTime):

    The date the asset was created, in Unix epoch time.

  • asset_last_update_date(DateTime):

    The date the asset was last updated, in Unix epoch time.

  • asset_status(Option<AssetStatus>):

    The current status of the asset, which contains a state and any error message.

  • asset_description(Option<String>):

    A description for the asset.

  • asset_composite_model_summaries(Option<Vec::<AssetCompositeModelSummary>>):

    The list of the immediate child custom composite model summaries for the asset.

  • asset_external_id(Option<String>):

    The external ID of the asset, if any.

• On failure, responds with SdkError<DescribeAssetError>

impl Client

pub fn describe_asset_composite_model( &self ) -> DescribeAssetCompositeModelFluentBuilder

Constructs a fluent builder for the DescribeAssetCompositeModel operation.

• The fluent builder is configurable:
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: true
    

    The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • asset_composite_model_id(impl Into<String>) / set_asset_composite_model_id(Option<String>):
    required: true
    

    The ID of a composite model on this asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
• On success, responds with DescribeAssetCompositeModelOutput with field(s):
  • asset_id(String):

    The ID of the asset, in UUID format. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs.

  • asset_composite_model_id(String):

    The ID of a composite model on this asset.

  • asset_composite_model_external_id(Option<String>):

    An external ID to assign to the asset model.

    If the composite model is a component-based composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it’s a part of.

  • asset_composite_model_path(Vec::<AssetCompositeModelPathSegment>):

    The path to the composite model listing the parent composite models.

  • asset_composite_model_name(String):

    The unique, friendly name for the composite model.

  • asset_composite_model_description(String):

    A description for the composite model.

  • asset_composite_model_type(String):

    The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

  • asset_composite_model_properties(Vec::<AssetProperty>):

    The property definitions of the composite model that was used to create the asset.

  • asset_composite_model_summaries(Vec::<AssetCompositeModelSummary>):

    The list of composite model summaries.

  • action_definitions(Option<Vec::<ActionDefinition>>):

    The available actions for a composite model on this asset.

• On failure, responds with SdkError<DescribeAssetCompositeModelError>

impl Client

pub fn describe_asset_model(&self) -> DescribeAssetModelFluentBuilder

Constructs a fluent builder for the DescribeAssetModel operation.

• The fluent builder is configurable:
  • asset_model_id(impl Into<String>) / set_asset_model_id(Option<String>):
    required: true
    

    The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • exclude_properties(bool) / set_exclude_properties(Option<bool>):
    required: false
    

    Whether or not to exclude asset model properties from the response.

    
    
• On success, responds with DescribeAssetModelOutput with field(s):
  • asset_model_id(String):

    The ID of the asset model, in UUID format.

  • asset_model_arn(String):

    The ARN of the asset model, which has the following format.

    arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

  • asset_model_name(String):

    The name of the asset model.

  • asset_model_description(String):

    The asset model’s description.

  • asset_model_properties(Vec::<AssetModelProperty>):

    The list of asset properties for the asset model.

    This object doesn’t include properties that you define in composite models. You can find composite model properties in the assetModelCompositeModels object.

  • asset_model_hierarchies(Vec::<AssetModelHierarchy>):

    A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.

  • asset_model_composite_models(Option<Vec::<AssetModelCompositeModel>>):

    The list of built-in composite models for the asset model, such as those with those of type AWS/ALARMS.

  • asset_model_creation_date(DateTime):

    The date the asset model was created, in Unix epoch time.

  • asset_model_last_update_date(DateTime):

    The date the asset model was last updated, in Unix epoch time.

  • asset_model_status(Option<AssetModelStatus>):

    The current status of the asset model, which contains a state and any error message.

  • 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.

  • asset_model_composite_model_summaries(Option<Vec::<AssetModelCompositeModelSummary>>):

    The list of the immediate child custom composite model summaries for the asset model.

  • asset_model_external_id(Option<String>):

    The external ID of the asset model, if any.

• On failure, responds with SdkError<DescribeAssetModelError>

impl Client

pub fn describe_asset_model_composite_model( &self ) -> DescribeAssetModelCompositeModelFluentBuilder

Constructs a fluent builder for the DescribeAssetModelCompositeModel operation.

• The fluent builder is configurable:
  • asset_model_id(impl Into<String>) / set_asset_model_id(Option<String>):
    required: true
    

    The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • asset_model_composite_model_id(impl Into<String>) / set_asset_model_composite_model_id(Option<String>):
    required: true
    

    The ID of a composite model on this asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
• On success, responds with DescribeAssetModelCompositeModelOutput with field(s):
  • asset_model_id(String):

    The ID of the asset model, in UUID format.

  • asset_model_composite_model_id(String):

    The ID of a composite model on this asset model.

  • asset_model_composite_model_external_id(Option<String>):

    The external ID of a composite model on this asset model.

  • asset_model_composite_model_path(Vec::<AssetModelCompositeModelPathSegment>):

    The path to the composite model listing the parent composite models.

  • asset_model_composite_model_name(String):

    The unique, friendly name for the composite model.

  • asset_model_composite_model_description(String):

    The description for the composite model.

  • asset_model_composite_model_type(String):

    The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

  • asset_model_composite_model_properties(Vec::<AssetModelProperty>):

    The property definitions of the composite model.

  • composition_details(Option<CompositionDetails>):

    Metadata for the composition relationship established by using composedAssetModelId in CreateAssetModelCompositeModel . For instance, an array detailing the path of the composition relationship for this composite model.

  • asset_model_composite_model_summaries(Vec::<AssetModelCompositeModelSummary>):

    The list of composite model summaries for the composite model.

  • action_definitions(Option<Vec::<ActionDefinition>>):

    The available actions for a composite model on this asset model.

• On failure, responds with SdkError<DescribeAssetModelCompositeModelError>

impl Client

pub fn describe_asset_property(&self) -> DescribeAssetPropertyFluentBuilder

Constructs a fluent builder for the DescribeAssetProperty operation.

• The fluent builder is configurable:
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: true
    

    The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • property_id(impl Into<String>) / set_property_id(Option<String>):
    required: true
    

    The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
• On success, responds with DescribeAssetPropertyOutput with field(s):
  • asset_id(String):

    The ID of the asset, in UUID format.

  • asset_name(String):

    The name of the asset.

  • asset_model_id(String):

    The ID of the asset model, in UUID format.

  • asset_property(Option<Property>):

    The asset property’s definition, alias, and notification state.

    This response includes this object for normal asset properties. If you describe an asset property in a composite model, this response includes the asset property information in compositeModel.

  • composite_model(Option<CompositeModelProperty>):

    The composite model that declares this asset property, if this asset property exists in a composite model.

  • asset_external_id(Option<String>):

    The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.

• On failure, responds with SdkError<DescribeAssetPropertyError>

impl Client

pub fn describe_bulk_import_job(&self) -> DescribeBulkImportJobFluentBuilder

Constructs a fluent builder for the DescribeBulkImportJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The ID of the job.

    
    
• On success, responds with DescribeBulkImportJobOutput with field(s):
  • job_id(String):

    The ID of the job.

  • job_name(String):

    The unique name that helps identify the job request.

  • job_status(JobStatus):

    The status of the bulk import job can be one of following values:

    • PENDING – IoT SiteWise is waiting for the current bulk import job to finish.

    • CANCELLED – The bulk import job has been canceled.

    • RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.

    • COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.

    • FAILED – IoT SiteWise couldn’t process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

    • COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

  • job_role_arn(String):

    The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.

  • files(Vec::<File>):

    The files in the specified Amazon S3 bucket that contain your data.

  • error_report_location(Option<ErrorReportLocation>):

    The Amazon S3 destination where errors associated with the job creation request are saved.

  • job_configuration(Option<JobConfiguration>):

    Contains the configuration information of a job, such as the file format used to save data in Amazon S3.

  • job_creation_date(DateTime):

    The date the job was created, in Unix epoch TIME.

  • job_last_update_date(DateTime):

    The date the job was last updated, in Unix epoch time.

  • adaptive_ingestion(Option<bool>):

    If set to true, ingest new data into IoT SiteWise storage. Measurements with notifications, metrics and transforms are computed. If set to false, historical data is ingested into IoT SiteWise as is.

  • delete_files_after_import(Option<bool>):

    If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.

• On failure, responds with SdkError<DescribeBulkImportJobError>

impl Client

pub fn describe_dashboard(&self) -> DescribeDashboardFluentBuilder

Constructs a fluent builder for the DescribeDashboard operation.

• The fluent builder is configurable:
  • dashboard_id(impl Into<String>) / set_dashboard_id(Option<String>):
    required: true
    

    The ID of the dashboard.

    
    
• On success, responds with DescribeDashboardOutput with field(s):
  • dashboard_id(String):

    The ID of the dashboard.

  • dashboard_arn(String):

    The ARN of the dashboard, which has the following format.

    arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}

  • dashboard_name(String):

    The name of the dashboard.

  • project_id(String):

    The ID of the project that the dashboard is in.

  • dashboard_description(Option<String>):

    The dashboard’s description.

  • dashboard_definition(String):

    The dashboard’s definition JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.

  • dashboard_creation_date(DateTime):

    The date the dashboard was created, in Unix epoch time.

  • dashboard_last_update_date(DateTime):

    The date the dashboard was last updated, in Unix epoch time.

• On failure, responds with SdkError<DescribeDashboardError>

impl Client

pub fn describe_default_encryption_configuration( &self ) -> DescribeDefaultEncryptionConfigurationFluentBuilder

Constructs a fluent builder for the DescribeDefaultEncryptionConfiguration operation.

• The fluent builder takes no input, just send it.
• On success, responds with DescribeDefaultEncryptionConfigurationOutput with field(s):
  • encryption_type(EncryptionType):

    The type of encryption used for the encryption configuration.

  • kms_key_arn(Option<String>):

    The key ARN of the customer managed key used for KMS encryption if you use KMS_BASED_ENCRYPTION.

  • configuration_status(Option<ConfigurationStatus>):

    The status of the account configuration. This contains the ConfigurationState. If there’s an error, it also contains the ErrorDetails.

• On failure, responds with SdkError<DescribeDefaultEncryptionConfigurationError>

impl Client

pub fn describe_gateway(&self) -> DescribeGatewayFluentBuilder

Constructs a fluent builder for the DescribeGateway operation.

• The fluent builder is configurable:
  • gateway_id(impl Into<String>) / set_gateway_id(Option<String>):
    required: true
    

    The ID of the gateway device.

    
    
• On success, responds with DescribeGatewayOutput with field(s):
  • gateway_id(String):

    The ID of the gateway device.

  • gateway_name(String):

    The name of the gateway.

  • gateway_arn(String):

    The ARN of the gateway, which has the following format.

    arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}

  • gateway_platform(Option<GatewayPlatform>):

    The gateway’s platform.

  • gateway_capability_summaries(Vec::<GatewayCapabilitySummary>):

    A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration’s definition, use DescribeGatewayCapabilityConfiguration.

  • creation_date(DateTime):

    The date the gateway was created, in Unix epoch time.

  • last_update_date(DateTime):

    The date the gateway was last updated, in Unix epoch time.

• On failure, responds with SdkError<DescribeGatewayError>

impl Client

pub fn describe_gateway_capability_configuration( &self ) -> DescribeGatewayCapabilityConfigurationFluentBuilder

Constructs a fluent builder for the DescribeGatewayCapabilityConfiguration operation.

• The fluent builder is configurable:
  • gateway_id(impl Into<String>) / set_gateway_id(Option<String>):
    required: true
    

    The ID of the gateway that defines the capability configuration.

    
    
  • capability_namespace(impl Into<String>) / set_capability_namespace(Option<String>):
    required: true
    

    The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.

    
    
• On success, responds with DescribeGatewayCapabilityConfigurationOutput with field(s):
  • gateway_id(String):

    The ID of the gateway that defines the capability configuration.

  • capability_namespace(String):

    The namespace of the gateway capability.

  • capability_configuration(String):

    The JSON document that defines the gateway capability’s configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.

  • capability_sync_status(CapabilitySyncStatus):

    The synchronization status of the capability configuration. The sync status can be one of the following:

    • IN_SYNC – The gateway is running the capability configuration.

    • OUT_OF_SYNC – The gateway hasn’t received the capability configuration.

    • SYNC_FAILED – The gateway rejected the capability configuration.

• On failure, responds with SdkError<DescribeGatewayCapabilityConfigurationError>

impl Client

pub fn describe_logging_options(&self) -> DescribeLoggingOptionsFluentBuilder

Constructs a fluent builder for the DescribeLoggingOptions operation.

• The fluent builder takes no input, just send it.
• On success, responds with DescribeLoggingOptionsOutput with field(s):
  • logging_options(Option<LoggingOptions>):

    The current logging options.

• On failure, responds with SdkError<DescribeLoggingOptionsError>

impl Client

pub fn describe_portal(&self) -> DescribePortalFluentBuilder

Constructs a fluent builder for the DescribePortal operation.

• The fluent builder is configurable:
  • portal_id(impl Into<String>) / set_portal_id(Option<String>):
    required: true
    

    The ID of the portal.

    
    
• On success, responds with DescribePortalOutput with field(s):
  • portal_id(String):

    The ID of the portal.

  • portal_arn(String):

    The ARN of the portal, which has the following format.

    arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

  • portal_name(String):

    The name of the portal.

  • portal_description(Option<String>):

    The portal’s description.

  • portal_client_id(String):

    The IAM Identity Center application generated client ID (used with IAM Identity Center API operations). IoT SiteWise includes portalClientId for only portals that use IAM Identity Center to authenticate users.

  • portal_start_url(String):

    The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.

  • portal_contact_email(String):

    The Amazon Web Services administrator’s contact email address.

  • portal_status(Option<PortalStatus>):

    The current status of the portal, which contains a state and any error message.

  • portal_creation_date(DateTime):

    The date the portal was created, in Unix epoch time.

  • portal_last_update_date(DateTime):

    The date the portal was last updated, in Unix epoch time.

  • portal_logo_image_location(Option<ImageLocation>):

    The portal’s logo image, which is available at a URL.

  • role_arn(Option<String>):

    The ARN of the service role that allows the portal’s users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.

  • portal_auth_mode(Option<AuthMode>):

    The service to use to authenticate users to the portal.

  • notification_sender_email(Option<String>):

    The email address that sends alarm notifications.

  • alarms(Option<Alarms>):

    Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.

• On failure, responds with SdkError<DescribePortalError>

impl Client

pub fn describe_project(&self) -> DescribeProjectFluentBuilder

Constructs a fluent builder for the DescribeProject operation.

• The fluent builder is configurable:
  • project_id(impl Into<String>) / set_project_id(Option<String>):
    required: true
    

    The ID of the project.

    
    
• On success, responds with DescribeProjectOutput with field(s):
  • project_id(String):

    The ID of the project.

  • project_arn(String):

    The ARN of the project, which has the following format.

    arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}

  • project_name(String):

    The name of the project.

  • portal_id(String):

    The ID of the portal that the project is in.

  • project_description(Option<String>):

    The project’s description.

  • project_creation_date(DateTime):

    The date the project was created, in Unix epoch time.

  • project_last_update_date(DateTime):

    The date the project was last updated, in Unix epoch time.

• On failure, responds with SdkError<DescribeProjectError>

impl Client

pub fn describe_storage_configuration( &self ) -> DescribeStorageConfigurationFluentBuilder

Constructs a fluent builder for the DescribeStorageConfiguration operation.

• The fluent builder takes no input, just send it.
• On success, responds with DescribeStorageConfigurationOutput with field(s):
  • storage_type(StorageType):

    The storage tier that you specified for your data. The storageType parameter can be one of the following values:

    • SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.

    • MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.

  • multi_layer_storage(Option<MultiLayerStorage>):

    Contains information about the storage destination.

  • disassociated_data_storage(Option<DisassociatedDataStorageState>):

    Contains the storage configuration for time series (data streams) that aren’t associated with asset properties. The disassociatedDataStorage can be one of the following values:

    • ENABLED – IoT SiteWise accepts time series that aren’t associated with asset properties.

      After the disassociatedDataStorage is enabled, you can’t disable it.

    • DISABLED – IoT SiteWise doesn’t accept time series (data streams) that aren’t associated with asset properties.

    For more information, see Data streams in the IoT SiteWise User Guide.

  • retention_period(Option<RetentionPeriod>):

    The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.

  • configuration_status(Option<ConfigurationStatus>):

    Contains current status information for the configuration.

  • last_update_date(Option<DateTime>):

    The date the storage configuration was last updated, in Unix epoch time.

  • warm_tier(Option<WarmTierState>):

    A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.

  • warm_tier_retention_period(Option<WarmTierRetentionPeriod>):

    Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.

• On failure, responds with SdkError<DescribeStorageConfigurationError>

impl Client

pub fn describe_time_series(&self) -> DescribeTimeSeriesFluentBuilder

Constructs a fluent builder for the DescribeTimeSeries operation.

• The fluent builder is configurable:
  • alias(impl Into<String>) / set_alias(Option<String>):
    required: false
    

    The alias that identifies the time series.

    
    
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: false
    

    The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • property_id(impl Into<String>) / set_property_id(Option<String>):
    required: false
    

    The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
• On success, responds with DescribeTimeSeriesOutput with field(s):
  • asset_id(Option<String>):

    The ID of the asset in which the asset property was created.

  • property_id(Option<String>):

    The ID of the asset property, in UUID format.

  • alias(Option<String>):

    The alias that identifies the time series.

  • time_series_id(String):

    The ID of the time series.

  • data_type(PropertyDataType):

    The data type of the time series.

    If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this time series.

  • data_type_spec(Option<String>):

    The data type of the structure for this time series. This parameter is required for time series that have the STRUCT data type.

    The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm composite models.

  • time_series_creation_date(DateTime):

    The date that the time series was created, in Unix epoch time.

  • time_series_last_update_date(DateTime):

    The date that the time series was last updated, in Unix epoch time.

  • time_series_arn(String):

    The ARN of the time series, which has the following format.

    arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}

• On failure, responds with SdkError<DescribeTimeSeriesError>

impl Client

pub fn disassociate_assets(&self) -> DisassociateAssetsFluentBuilder

Constructs a fluent builder for the DisassociateAssets operation.

• The fluent builder is configurable:
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: true
    

    The ID of the parent asset from which to disassociate the child asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • hierarchy_id(impl Into<String>) / set_hierarchy_id(Option<String>):
    required: true
    

    The ID of a hierarchy in the parent asset’s model. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) Hierarchies allow different groupings of assets to be formed that all come from the same asset model. You can use the hierarchy ID to identify the correct asset to disassociate. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

    
    
  • child_asset_id(impl Into<String>) / set_child_asset_id(Option<String>):
    required: true
    

    The ID of the child asset to disassociate. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DisassociateAssetsOutput
• On failure, responds with SdkError<DisassociateAssetsError>

impl Client

pub fn disassociate_time_series_from_asset_property( &self ) -> DisassociateTimeSeriesFromAssetPropertyFluentBuilder

Constructs a fluent builder for the DisassociateTimeSeriesFromAssetProperty operation.

• The fluent builder is configurable:
  • alias(impl Into<String>) / set_alias(Option<String>):
    required: true
    

    The alias that identifies the time series.

    
    
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: true
    

    The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • property_id(impl Into<String>) / set_property_id(Option<String>):
    required: true
    

    The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DisassociateTimeSeriesFromAssetPropertyOutput
• On failure, responds with SdkError<DisassociateTimeSeriesFromAssetPropertyError>

impl Client

pub fn execute_action(&self) -> ExecuteActionFluentBuilder

Constructs a fluent builder for the ExecuteAction operation.

• The fluent builder is configurable:
  • target_resource(TargetResource) / set_target_resource(Option<TargetResource>):
    required: true
    

    The resource the action will be taken on.

    
    
  • action_definition_id(impl Into<String>) / set_action_definition_id(Option<String>):
    required: true
    

    The ID of the action definition.

    
    
  • action_payload(ActionPayload) / set_action_payload(Option<ActionPayload>):
    required: true
    

    The JSON payload of the action.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ExecuteActionOutput with field(s):
  • action_id(String):

    The ID of the action.

• On failure, responds with SdkError<ExecuteActionError>

impl Client

pub fn execute_query(&self) -> ExecuteQueryFluentBuilder

Constructs a fluent builder for the ExecuteQuery operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • query_statement(impl Into<String>) / set_query_statement(Option<String>):
    required: true
    

    The IoT SiteWise query statement.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The string that specifies the next page of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time. The default is 25.

    
    
• On success, responds with ExecuteQueryOutput with field(s):
  • columns(Option<Vec::<ColumnInfo>>):

    Represents a single column in the query results.

  • rows(Option<Vec::<Row>>):

    Represents a single row in the query results.

  • next_token(Option<String>):

    The string that specifies the next page of results.

• On failure, responds with SdkError<ExecuteQueryError>

impl Client

pub fn get_asset_property_aggregates( &self ) -> GetAssetPropertyAggregatesFluentBuilder

Constructs a fluent builder for the GetAssetPropertyAggregates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: false
    

    The ID of the asset, in UUID format.

    
    
  • property_id(impl Into<String>) / set_property_id(Option<String>):
    required: false
    

    The ID of the asset property, in UUID format.

    
    
  • property_alias(impl Into<String>) / set_property_alias(Option<String>):
    required: false
    

    The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

    
    
  • aggregate_types(AggregateType) / set_aggregate_types(Option<Vec::<AggregateType>>):
    required: true
    

    The data aggregating function.

    
    
  • resolution(impl Into<String>) / set_resolution(Option<String>):
    required: true
    

    The time interval over which to aggregate data.

    
    
  • qualities(Quality) / set_qualities(Option<Vec::<Quality>>):
    required: false
    

    The quality by which to filter asset data.

    
    
  • start_date(DateTime) / set_start_date(Option<DateTime>):
    required: true
    

    The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

    
    
  • end_date(DateTime) / set_end_date(Option<DateTime>):
    required: true
    

    The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

    
    
  • time_ordering(TimeOrdering) / set_time_ordering(Option<TimeOrdering>):
    required: false
    

    The chronological sorting order of the requested information.

    Default: ASCENDING

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

    • The size of the result set is equal to 1 MB.

    • The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 2500.

    
    
• On success, responds with GetAssetPropertyAggregatesOutput with field(s):
  • aggregated_values(Vec::<AggregatedValue>):

    The requested aggregated values.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<GetAssetPropertyAggregatesError>

impl Client

pub fn get_asset_property_value(&self) -> GetAssetPropertyValueFluentBuilder

Constructs a fluent builder for the GetAssetPropertyValue operation.

• The fluent builder is configurable:
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: false
    

    The ID of the asset, in UUID format.

    
    
  • property_id(impl Into<String>) / set_property_id(Option<String>):
    required: false
    

    The ID of the asset property, in UUID format.

    
    
  • property_alias(impl Into<String>) / set_property_alias(Option<String>):
    required: false
    

    The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

    
    
• On success, responds with GetAssetPropertyValueOutput with field(s):
  • property_value(Option<AssetPropertyValue>):

    The current asset property value.

• On failure, responds with SdkError<GetAssetPropertyValueError>

impl Client

pub fn get_asset_property_value_history( &self ) -> GetAssetPropertyValueHistoryFluentBuilder

Constructs a fluent builder for the GetAssetPropertyValueHistory operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: false
    

    The ID of the asset, in UUID format.

    
    
  • property_id(impl Into<String>) / set_property_id(Option<String>):
    required: false
    

    The ID of the asset property, in UUID format.

    
    
  • property_alias(impl Into<String>) / set_property_alias(Option<String>):
    required: false
    

    The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

    
    
  • start_date(DateTime) / set_start_date(Option<DateTime>):
    required: false
    

    The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

    
    
  • end_date(DateTime) / set_end_date(Option<DateTime>):
    required: false
    

    The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

    
    
  • qualities(Quality) / set_qualities(Option<Vec::<Quality>>):
    required: false
    

    The quality by which to filter asset data.

    
    
  • time_ordering(TimeOrdering) / set_time_ordering(Option<TimeOrdering>):
    required: false
    

    The chronological sorting order of the requested information.

    Default: ASCENDING

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

    • The size of the result set is equal to 4 MB.

    • The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 20000.

    
    
• On success, responds with GetAssetPropertyValueHistoryOutput with field(s):
  • asset_property_value_history(Vec::<AssetPropertyValue>):

    The asset property’s value history.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<GetAssetPropertyValueHistoryError>

impl Client

pub fn get_interpolated_asset_property_values( &self ) -> GetInterpolatedAssetPropertyValuesFluentBuilder

Constructs a fluent builder for the GetInterpolatedAssetPropertyValues operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: false
    

    The ID of the asset, in UUID format.

    
    
  • property_id(impl Into<String>) / set_property_id(Option<String>):
    required: false
    

    The ID of the asset property, in UUID format.

    
    
  • property_alias(impl Into<String>) / set_property_alias(Option<String>):
    required: false
    

    The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

    
    
  • start_time_in_seconds(i64) / set_start_time_in_seconds(Option<i64>):
    required: true
    

    The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.

    
    
  • start_time_offset_in_nanos(i32) / set_start_time_offset_in_nanos(Option<i32>):
    required: false
    

    The nanosecond offset converted from startTimeInSeconds.

    
    
  • end_time_in_seconds(i64) / set_end_time_in_seconds(Option<i64>):
    required: true
    

    The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.

    
    
  • end_time_offset_in_nanos(i32) / set_end_time_offset_in_nanos(Option<i32>):
    required: false
    

    The nanosecond offset converted from endTimeInSeconds.

    
    
  • quality(Quality) / set_quality(Option<Quality>):
    required: true
    

    The quality of the asset property value. You can use this parameter as a filter to choose only the asset property values that have a specific quality.

    
    
  • interval_in_seconds(i64) / set_interval_in_seconds(Option<i64>):
    required: true
    

    The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request. If not specified, the default value is 10.

    
    
  • r#type(impl Into<String>) / set_type(Option<String>):
    required: true
    

    The interpolation type.

    Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION

    • LINEAR_INTERPOLATION – Estimates missing data using linear interpolation.

      For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM, the second interpolated value on July 3, 2021, at 9 AM, and so on.

    • LOCF_INTERPOLATION – Estimates missing data using last observation carried forward interpolation

      If no data point is found for an interval, IoT SiteWise returns the last observed data point for the previous interval and carries forward this interpolated value until a new data point is found.

      For example, you can get the state of an on-off valve every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the last observed data point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first interpolated value. If a data point isn’t found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.

    
    
  • interval_window_in_seconds(i64) / set_interval_window_in_seconds(Option<i64>):
    required: false
    

    The query interval for the window, in seconds. IoT SiteWise computes each interpolated value by using data points from the timestamp of each interval, minus the window to the timestamp of each interval plus the window. If not specified, the window ranges between the start time minus the interval and the end time plus the interval.

    • If you specify a value for the intervalWindowInSeconds parameter, the value for the type parameter must be LINEAR_INTERPOLATION.

    • If a data point isn’t found during the specified query window, IoT SiteWise won’t return an interpolated value for the interval. This indicates that there’s a gap in the ingested data points.

    For example, you can get the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to compute the second interpolated value, and so on.

    
    
• On success, responds with GetInterpolatedAssetPropertyValuesOutput with field(s):
  • interpolated_asset_property_values(Vec::<InterpolatedAssetPropertyValue>):

    The requested interpolated values.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<GetInterpolatedAssetPropertyValuesError>

impl Client

pub fn list_access_policies(&self) -> ListAccessPoliciesFluentBuilder

Constructs a fluent builder for the ListAccessPolicies operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • identity_type(IdentityType) / set_identity_type(Option<IdentityType>):
    required: false
    

    The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required if you specify identityId.

    
    
  • identity_id(impl Into<String>) / set_identity_id(Option<String>):
    required: false
    

    The ID of the identity. This parameter is required if you specify USER or GROUP for identityType.

    
    
  • resource_type(ResourceType) / set_resource_type(Option<ResourceType>):
    required: false
    

    The type of resource (portal or project). This parameter is required if you specify resourceId.

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: false
    

    The ID of the resource. This parameter is required if you specify resourceType.

    
    
  • iam_arn(impl Into<String>) / set_iam_arn(Option<String>):
    required: false
    

    The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide. This parameter is required if you specify IAM for identityType.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request.

    Default: 50

    
    
• On success, responds with ListAccessPoliciesOutput with field(s):
  • access_policy_summaries(Vec::<AccessPolicySummary>):

    A list that summarizes each access policy.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListAccessPoliciesError>

impl Client

pub fn list_actions(&self) -> ListActionsFluentBuilder

Constructs a fluent builder for the ListActions operation.

• The fluent builder is configurable:
  • target_resource_type(TargetResourceType) / set_target_resource_type(Option<TargetResourceType>):
    required: true
    

    The type of resource.

    
    
  • target_resource_id(impl Into<String>) / set_target_resource_id(Option<String>):
    required: true
    

    The ID of the target resource.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request.

    
    
• On success, responds with ListActionsOutput with field(s):
  • action_summaries(Vec::<ActionSummary>):

    A list that summarizes the actions associated with the specified asset.

  • next_token(String):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListActionsError>

impl Client

pub fn list_asset_model_composite_models( &self ) -> ListAssetModelCompositeModelsFluentBuilder

Constructs a fluent builder for the ListAssetModelCompositeModels operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • asset_model_id(impl Into<String>) / set_asset_model_id(Option<String>):
    required: true
    

    The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request.

    Default: 50

    
    
• On success, responds with ListAssetModelCompositeModelsOutput with field(s):
  • asset_model_composite_model_summaries(Vec::<AssetModelCompositeModelSummary>):

    A list that summarizes each composite model.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListAssetModelCompositeModelsError>

impl Client

pub fn list_asset_model_properties( &self ) -> ListAssetModelPropertiesFluentBuilder

Constructs a fluent builder for the ListAssetModelProperties operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • asset_model_id(impl Into<String>) / set_asset_model_id(Option<String>):
    required: true
    

    The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request. If not specified, the default value is 50.

    
    
  • filter(ListAssetModelPropertiesFilter) / set_filter(Option<ListAssetModelPropertiesFilter>):
    required: false
    

    Filters the requested list of asset model properties. You can choose one of the following options:

    • ALL – The list includes all asset model properties for a given asset model ID.

    • BASE – The list includes only base asset model properties for a given asset model ID.

    Default: BASE

    
    
• On success, responds with ListAssetModelPropertiesOutput with field(s):
  • asset_model_property_summaries(Vec::<AssetModelPropertySummary>):

    A list that summarizes the properties associated with the specified asset model.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListAssetModelPropertiesError>

impl Client

pub fn list_asset_models(&self) -> ListAssetModelsFluentBuilder

Constructs a fluent builder for the ListAssetModels operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request.

    Default: 50

    
    
  • asset_model_types(AssetModelType) / set_asset_model_types(Option<Vec::<AssetModelType>>):
    required: false
    

    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.

    
    
• On success, responds with ListAssetModelsOutput with field(s):
  • asset_model_summaries(Vec::<AssetModelSummary>):

    A list that summarizes each asset model.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListAssetModelsError>

impl Client

pub fn list_asset_properties(&self) -> ListAssetPropertiesFluentBuilder

Constructs a fluent builder for the ListAssetProperties operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: true
    

    The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request. If not specified, the default value is 50.

    
    
  • filter(ListAssetPropertiesFilter) / set_filter(Option<ListAssetPropertiesFilter>):
    required: false
    

    Filters the requested list of asset properties. You can choose one of the following options:

    • ALL – The list includes all asset properties for a given asset model ID.

    • BASE – The list includes only base asset properties for a given asset model ID.

    Default: BASE

    
    
• On success, responds with ListAssetPropertiesOutput with field(s):
  • asset_property_summaries(Vec::<AssetPropertySummary>):

    A list that summarizes the properties associated with the specified asset.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListAssetPropertiesError>

impl Client

pub fn list_asset_relationships(&self) -> ListAssetRelationshipsFluentBuilder

Constructs a fluent builder for the ListAssetRelationships operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: true
    

    The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • traversal_type(TraversalType) / set_traversal_type(Option<TraversalType>):
    required: true
    

    The type of traversal to use to identify asset relationships. Choose the following option:

    • PATH_TO_ROOT – Identify the asset’s parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request.

    
    
• On success, responds with ListAssetRelationshipsOutput with field(s):
  • asset_relationship_summaries(Vec::<AssetRelationshipSummary>):

    A list that summarizes each asset relationship.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListAssetRelationshipsError>

impl Client

pub fn list_assets(&self) -> ListAssetsFluentBuilder

Constructs a fluent builder for the ListAssets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request.

    Default: 50

    
    
  • asset_model_id(impl Into<String>) / set_asset_model_id(Option<String>):
    required: false
    

    The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • filter(ListAssetsFilter) / set_filter(Option<ListAssetsFilter>):
    required: false
    

    The filter for the requested list of assets. Choose one of the following options:

    • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.

    • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

    Default: ALL

    
    
• On success, responds with ListAssetsOutput with field(s):
  • asset_summaries(Vec::<AssetSummary>):

    A list that summarizes each asset.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListAssetsError>

impl Client

pub fn list_associated_assets(&self) -> ListAssociatedAssetsFluentBuilder

Constructs a fluent builder for the ListAssociatedAssets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: true
    

    The ID of the asset to query. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • hierarchy_id(impl Into<String>) / set_hierarchy_id(Option<String>):
    required: false
    

    The ID of the hierarchy by which child assets are associated to the asset. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.

    For more information, see Asset hierarchies in the IoT SiteWise User Guide.

    
    
  • traversal_direction(TraversalDirection) / set_traversal_direction(Option<TraversalDirection>):
    required: false
    

    The direction to list associated assets. Choose one of the following options:

    • CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD.

    • PARENT – The list includes the asset’s parent asset.

    Default: CHILD

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request.

    Default: 50

    
    
• On success, responds with ListAssociatedAssetsOutput with field(s):
  • asset_summaries(Vec::<AssociatedAssetsSummary>):

    A list that summarizes the associated assets.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListAssociatedAssetsError>

impl Client

pub fn list_bulk_import_jobs(&self) -> ListBulkImportJobsFluentBuilder

Constructs a fluent builder for the ListBulkImportJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request.

    
    
  • filter(ListBulkImportJobsFilter) / set_filter(Option<ListBulkImportJobsFilter>):
    required: false
    

    You can use a filter to select the bulk import jobs that you want to retrieve.

    
    
• On success, responds with ListBulkImportJobsOutput with field(s):
  • job_summaries(Vec::<JobSummary>):

    One or more job summaries to list.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListBulkImportJobsError>

impl Client

pub fn list_composition_relationships( &self ) -> ListCompositionRelationshipsFluentBuilder

Constructs a fluent builder for the ListCompositionRelationships operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • asset_model_id(impl Into<String>) / set_asset_model_id(Option<String>):
    required: true
    

    The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request.

    Default: 50

    
    
• On success, responds with ListCompositionRelationshipsOutput with field(s):
  • composition_relationship_summaries(Vec::<CompositionRelationshipSummary>):

    A list that summarizes each composition relationship.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListCompositionRelationshipsError>

impl Client

pub fn list_dashboards(&self) -> ListDashboardsFluentBuilder

Constructs a fluent builder for the ListDashboards operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • project_id(impl Into<String>) / set_project_id(Option<String>):
    required: true
    

    The ID of the project.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request.

    Default: 50

    
    
• On success, responds with ListDashboardsOutput with field(s):
  • dashboard_summaries(Vec::<DashboardSummary>):

    A list that summarizes each dashboard in the project.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListDashboardsError>

impl Client

pub fn list_gateways(&self) -> ListGatewaysFluentBuilder

Constructs a fluent builder for the ListGateways operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request.

    Default: 50

    
    
• On success, responds with ListGatewaysOutput with field(s):
  • gateway_summaries(Vec::<GatewaySummary>):

    A list that summarizes each gateway.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListGatewaysError>

impl Client

pub fn list_portals(&self) -> ListPortalsFluentBuilder

Constructs a fluent builder for the ListPortals operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request.

    Default: 50

    
    
• On success, responds with ListPortalsOutput with field(s):
  • portal_summaries(Option<Vec::<PortalSummary>>):

    A list that summarizes each portal.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListPortalsError>

impl Client

pub fn list_project_assets(&self) -> ListProjectAssetsFluentBuilder

Constructs a fluent builder for the ListProjectAssets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • project_id(impl Into<String>) / set_project_id(Option<String>):
    required: true
    

    The ID of the project.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request.

    Default: 50

    
    
• On success, responds with ListProjectAssetsOutput with field(s):
  • asset_ids(Vec::<String>):

    A list that contains the IDs of each asset associated with the project.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListProjectAssetsError>

impl Client

pub fn list_projects(&self) -> ListProjectsFluentBuilder

Constructs a fluent builder for the ListProjects operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • portal_id(impl Into<String>) / set_portal_id(Option<String>):
    required: true
    

    The ID of the portal.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request.

    Default: 50

    
    
• On success, responds with ListProjectsOutput with field(s):
  • project_summaries(Vec::<ProjectSummary>):

    A list that summarizes each project in the portal.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListProjectsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

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

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_time_series(&self) -> ListTimeSeriesFluentBuilder

Constructs a fluent builder for the ListTimeSeries operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to be used for the next set of paginated results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return for each paginated request.

    
    
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: false
    

    The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • alias_prefix(impl Into<String>) / set_alias_prefix(Option<String>):
    required: false
    

    The alias prefix of the time series.

    
    
  • time_series_type(ListTimeSeriesType) / set_time_series_type(Option<ListTimeSeriesType>):
    required: false
    

    The type of the time series. The time series type can be one of the following values:

    • ASSOCIATED – The time series is associated with an asset property.

    • DISASSOCIATED – The time series isn’t associated with any asset property.

    
    
• On success, responds with ListTimeSeriesOutput with field(s):
  • time_series_summaries(Vec::<TimeSeriesSummary>):

    One or more time series summaries to list.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListTimeSeriesError>

impl Client

pub fn put_default_encryption_configuration( &self ) -> PutDefaultEncryptionConfigurationFluentBuilder

Constructs a fluent builder for the PutDefaultEncryptionConfiguration operation.

• The fluent builder is configurable:
  • encryption_type(EncryptionType) / set_encryption_type(Option<EncryptionType>):
    required: true
    

    The type of encryption used for the encryption configuration.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    The Key ID of the customer managed key used for KMS encryption. This is required if you use KMS_BASED_ENCRYPTION.

    
    
• On success, responds with PutDefaultEncryptionConfigurationOutput with field(s):
  • encryption_type(EncryptionType):

    The type of encryption used for the encryption configuration.

  • kms_key_arn(Option<String>):

    The Key ARN of the KMS key used for KMS encryption if you use KMS_BASED_ENCRYPTION.

  • configuration_status(Option<ConfigurationStatus>):

    The status of the account configuration. This contains the ConfigurationState. If there is an error, it also contains the ErrorDetails.

• On failure, responds with SdkError<PutDefaultEncryptionConfigurationError>

impl Client

pub fn put_logging_options(&self) -> PutLoggingOptionsFluentBuilder

Constructs a fluent builder for the PutLoggingOptions operation.

• The fluent builder is configurable:
  • logging_options(LoggingOptions) / set_logging_options(Option<LoggingOptions>):
    required: true
    

    The logging options to set.

    
    
• On success, responds with PutLoggingOptionsOutput
• On failure, responds with SdkError<PutLoggingOptionsError>

impl Client

pub fn put_storage_configuration(&self) -> PutStorageConfigurationFluentBuilder

Constructs a fluent builder for the PutStorageConfiguration operation.

• The fluent builder is configurable:
  • storage_type(StorageType) / set_storage_type(Option<StorageType>):
    required: true
    

    The storage tier that you specified for your data. The storageType parameter can be one of the following values:

    • SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.

    • MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.

    
    
  • multi_layer_storage(MultiLayerStorage) / set_multi_layer_storage(Option<MultiLayerStorage>):
    required: false
    

    Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the storage type, you must specify a MultiLayerStorage object.

    
    
  • disassociated_data_storage(DisassociatedDataStorageState) / set_disassociated_data_storage(Option<DisassociatedDataStorageState>):
    required: false
    

    Contains the storage configuration for time series (data streams) that aren’t associated with asset properties. The disassociatedDataStorage can be one of the following values:

    • ENABLED – IoT SiteWise accepts time series that aren’t associated with asset properties.

      After the disassociatedDataStorage is enabled, you can’t disable it.

    • DISABLED – IoT SiteWise doesn’t accept time series (data streams) that aren’t associated with asset properties.

    For more information, see Data streams in the IoT SiteWise User Guide.

    
    
  • retention_period(RetentionPeriod) / set_retention_period(Option<RetentionPeriod>):
    required: false
    

    The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.

    
    
  • warm_tier(WarmTierState) / set_warm_tier(Option<WarmTierState>):
    required: false
    

    A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.

    
    
  • warm_tier_retention_period(WarmTierRetentionPeriod) / set_warm_tier_retention_period(Option<WarmTierRetentionPeriod>):
    required: false
    

    Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.

    
    
• On success, responds with PutStorageConfigurationOutput with field(s):
  • storage_type(StorageType):

    The storage tier that you specified for your data. The storageType parameter can be one of the following values:

    • SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.

    • MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.

  • multi_layer_storage(Option<MultiLayerStorage>):

    Contains information about the storage destination.

  • disassociated_data_storage(Option<DisassociatedDataStorageState>):

    Contains the storage configuration for time series (data streams) that aren’t associated with asset properties. The disassociatedDataStorage can be one of the following values:

    • ENABLED – IoT SiteWise accepts time series that aren’t associated with asset properties.

      After the disassociatedDataStorage is enabled, you can’t disable it.

    • DISABLED – IoT SiteWise doesn’t accept time series (data streams) that aren’t associated with asset properties.

    For more information, see Data streams in the IoT SiteWise User Guide.

  • retention_period(Option<RetentionPeriod>):

    The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.

  • configuration_status(Option<ConfigurationStatus>):

    Contains current status information for the configuration.

  • warm_tier(Option<WarmTierState>):

    A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.

  • warm_tier_retention_period(Option<WarmTierRetentionPeriod>):

    Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.

• On failure, responds with SdkError<PutStorageConfigurationError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource to tag.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

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

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource to untag.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    A list of keys for tags to remove from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_access_policy(&self) -> UpdateAccessPolicyFluentBuilder

Constructs a fluent builder for the UpdateAccessPolicy operation.

• The fluent builder is configurable:
  • access_policy_id(impl Into<String>) / set_access_policy_id(Option<String>):
    required: true
    

    The ID of the access policy.

    
    
  • access_policy_identity(Identity) / set_access_policy_identity(Option<Identity>):
    required: true
    

    The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.

    
    
  • access_policy_resource(Resource) / set_access_policy_resource(Option<Resource>):
    required: true
    

    The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.

    
    
  • access_policy_permission(Permission) / set_access_policy_permission(Option<Permission>):
    required: true
    

    The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with UpdateAccessPolicyOutput
• On failure, responds with SdkError<UpdateAccessPolicyError>

impl Client

pub fn update_asset(&self) -> UpdateAssetFluentBuilder

Constructs a fluent builder for the UpdateAsset operation.

• The fluent builder is configurable:
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: true
    

    The ID of the asset to update. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • asset_name(impl Into<String>) / set_asset_name(Option<String>):
    required: true
    

    A friendly name for the asset.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
  • asset_description(impl Into<String>) / set_asset_description(Option<String>):
    required: false
    

    A description for the asset.

    
    
  • asset_external_id(impl Into<String>) / set_asset_external_id(Option<String>):
    required: false
    

    An external ID to assign to the asset. The asset must not already have an external ID. 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.

    
    
• On success, responds with UpdateAssetOutput with field(s):
  • asset_status(Option<AssetStatus>):

    The status of the asset, which contains a state (UPDATING after successfully calling this operation) and any error message.

• On failure, responds with SdkError<UpdateAssetError>

impl Client

pub fn update_asset_model(&self) -> UpdateAssetModelFluentBuilder

Constructs a fluent builder for the UpdateAssetModel operation.

• The fluent builder is configurable:
  • asset_model_id(impl Into<String>) / set_asset_model_id(Option<String>):
    required: true
    

    The ID of the asset model to update. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • asset_model_name(impl Into<String>) / set_asset_model_name(Option<String>):
    required: true
    

    A unique, friendly name for the asset model.

    
    
  • asset_model_description(impl Into<String>) / set_asset_model_description(Option<String>):
    required: false
    

    A description for the asset model.

    
    
  • asset_model_properties(AssetModelProperty) / set_asset_model_properties(Option<Vec::<AssetModelProperty>>):
    required: false
    

    The updated 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(AssetModelHierarchy) / set_asset_model_hierarchies(Option<Vec::<AssetModelHierarchy>>):
    required: false
    

    The updated 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(AssetModelCompositeModel) / set_asset_model_composite_models(Option<Vec::<AssetModelCompositeModel>>):
    required: false
    

    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(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
  • asset_model_external_id(impl Into<String>) / set_asset_model_external_id(Option<String>):
    required: false
    

    An external ID to assign to the asset model. The asset model must not already have an external ID. 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.

    
    
• On success, responds with UpdateAssetModelOutput with field(s):
  • asset_model_status(Option<AssetModelStatus>):

    The status of the asset model, which contains a state (UPDATING after successfully calling this operation) and any error message.

• On failure, responds with SdkError<UpdateAssetModelError>

impl Client

pub fn update_asset_model_composite_model( &self ) -> UpdateAssetModelCompositeModelFluentBuilder

Constructs a fluent builder for the UpdateAssetModelCompositeModel operation.

• The fluent builder is configurable:
  • asset_model_id(impl Into<String>) / set_asset_model_id(Option<String>):
    required: true
    

    The ID of the asset model, in UUID format.

    
    
  • asset_model_composite_model_id(impl Into<String>) / set_asset_model_composite_model_id(Option<String>):
    required: true
    

    The ID of a composite model on this asset model.

    
    
  • asset_model_composite_model_external_id(impl Into<String>) / set_asset_model_composite_model_external_id(Option<String>):
    required: false
    

    An external ID to assign to the asset model. You can only set the external ID of the asset model if it wasn’t set when it was created, or you’re setting it to the exact same thing as when it was created.

    
    
  • asset_model_composite_model_description(impl Into<String>) / set_asset_model_composite_model_description(Option<String>):
    required: false
    

    A description for the composite model.

    
    
  • asset_model_composite_model_name(impl Into<String>) / set_asset_model_composite_model_name(Option<String>):
    required: true
    

    A unique, friendly name for the composite model.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
  • asset_model_composite_model_properties(AssetModelProperty) / set_asset_model_composite_model_properties(Option<Vec::<AssetModelProperty>>):
    required: false
    

    The property definitions of the composite model. For more information, see .

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

    
    
• On success, responds with UpdateAssetModelCompositeModelOutput with field(s):
  • asset_model_composite_model_path(Vec::<AssetModelCompositeModelPathSegment>):

    The path to the composite model listing the parent composite models.

  • asset_model_status(Option<AssetModelStatus>):

    Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide.

• On failure, responds with SdkError<UpdateAssetModelCompositeModelError>

impl Client

pub fn update_asset_property(&self) -> UpdateAssetPropertyFluentBuilder

Constructs a fluent builder for the UpdateAssetProperty operation.

• The fluent builder is configurable:
  • asset_id(impl Into<String>) / set_asset_id(Option<String>):
    required: true
    

    The ID of the asset to be updated. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • property_id(impl Into<String>) / set_property_id(Option<String>):
    required: true
    

    The ID of the asset property to be updated. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

    
    
  • property_alias(impl Into<String>) / set_property_alias(Option<String>):
    required: false
    

    The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

    If you omit this parameter, the alias is removed from the property.

    
    
  • property_notification_state(PropertyNotificationState) / set_property_notification_state(Option<PropertyNotificationState>):
    required: false
    

    The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide.

    If you omit this parameter, the notification state is set to DISABLED.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
  • property_unit(impl Into<String>) / set_property_unit(Option<String>):
    required: false
    

    The unit of measure (such as Newtons or RPM) of the asset property. If you don’t specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.

    
    
• On success, responds with UpdateAssetPropertyOutput
• On failure, responds with SdkError<UpdateAssetPropertyError>

impl Client

pub fn update_dashboard(&self) -> UpdateDashboardFluentBuilder

Constructs a fluent builder for the UpdateDashboard operation.

• The fluent builder is configurable:
  • dashboard_id(impl Into<String>) / set_dashboard_id(Option<String>):
    required: true
    

    The ID of the dashboard to update.

    
    
  • dashboard_name(impl Into<String>) / set_dashboard_name(Option<String>):
    required: true
    

    A new friendly name for the dashboard.

    
    
  • dashboard_description(impl Into<String>) / set_dashboard_description(Option<String>):
    required: false
    

    A new description for the dashboard.

    
    
  • dashboard_definition(impl Into<String>) / set_dashboard_definition(Option<String>):
    required: true
    

    The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with UpdateDashboardOutput
• On failure, responds with SdkError<UpdateDashboardError>

impl Client

pub fn update_gateway(&self) -> UpdateGatewayFluentBuilder

Constructs a fluent builder for the UpdateGateway operation.

• The fluent builder is configurable:
  • gateway_id(impl Into<String>) / set_gateway_id(Option<String>):
    required: true
    

    The ID of the gateway to update.

    
    
  • gateway_name(impl Into<String>) / set_gateway_name(Option<String>):
    required: true
    

    A unique, friendly name for the gateway.

    
    
• On success, responds with UpdateGatewayOutput
• On failure, responds with SdkError<UpdateGatewayError>

impl Client

pub fn update_gateway_capability_configuration( &self ) -> UpdateGatewayCapabilityConfigurationFluentBuilder

Constructs a fluent builder for the UpdateGatewayCapabilityConfiguration operation.

• The fluent builder is configurable:
  • gateway_id(impl Into<String>) / set_gateway_id(Option<String>):
    required: true
    

    The ID of the gateway to be updated.

    
    
  • capability_namespace(impl Into<String>) / set_capability_namespace(Option<String>):
    required: true
    

    The namespace of the gateway capability configuration to be updated. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.

    
    
  • capability_configuration(impl Into<String>) / set_capability_configuration(Option<String>):
    required: true
    

    The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.

    
    
• On success, responds with UpdateGatewayCapabilityConfigurationOutput with field(s):
  • capability_namespace(String):

    The namespace of the gateway capability.

  • capability_sync_status(CapabilitySyncStatus):

    The synchronization status of the capability configuration. The sync status can be one of the following:

    • IN_SYNC – The gateway is running the capability configuration.

    • OUT_OF_SYNC – The gateway hasn’t received the capability configuration.

    • SYNC_FAILED – The gateway rejected the capability configuration.

    After you update a capability configuration, its sync status is OUT_OF_SYNC until the gateway receives and applies or rejects the updated configuration.

• On failure, responds with SdkError<UpdateGatewayCapabilityConfigurationError>

impl Client

pub fn update_portal(&self) -> UpdatePortalFluentBuilder

Constructs a fluent builder for the UpdatePortal operation.

• The fluent builder is configurable:
  • portal_id(impl Into<String>) / set_portal_id(Option<String>):
    required: true
    

    The ID of the portal to update.

    
    
  • portal_name(impl Into<String>) / set_portal_name(Option<String>):
    required: true
    

    A new friendly name for the portal.

    
    
  • portal_description(impl Into<String>) / set_portal_description(Option<String>):
    required: false
    

    A new description for the portal.

    
    
  • portal_contact_email(impl Into<String>) / set_portal_contact_email(Option<String>):
    required: true
    

    The Amazon Web Services administrator’s contact email address.

    
    
  • portal_logo_image(Image) / set_portal_logo_image(Option<Image>):
    required: false
    

    Contains an image that is one of the following:

    • An image file. Choose this option to upload a new image.

    • The ID of an existing image. Choose this option to keep an existing image.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The ARN of a service role that allows the portal’s users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
  • notification_sender_email(impl Into<String>) / set_notification_sender_email(Option<String>):
    required: false
    

    The email address that sends alarm notifications.

    
    
  • alarms(Alarms) / set_alarms(Option<Alarms>):
    required: false
    

    Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.

    
    
• On success, responds with UpdatePortalOutput with field(s):
  • portal_status(Option<PortalStatus>):

    The status of the portal, which contains a state (UPDATING after successfully calling this operation) and any error message.

• On failure, responds with SdkError<UpdatePortalError>

impl Client

pub fn update_project(&self) -> UpdateProjectFluentBuilder

Constructs a fluent builder for the UpdateProject operation.

• The fluent builder is configurable:
  • project_id(impl Into<String>) / set_project_id(Option<String>):
    required: true
    

    The ID of the project to update.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    A new friendly name for the project.

    
    
  • project_description(impl Into<String>) / set_project_description(Option<String>):
    required: false
    

    A new description for the project.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with UpdateProjectOutput
• On failure, responds with SdkError<UpdateProjectError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl Waiters for Client

fn wait_until_asset_active(&self) -> AssetActiveFluentBuilder

Wait for asset_active

fn wait_until_asset_not_exists(&self) -> AssetNotExistsFluentBuilder

Wait for asset_not_exists

fn wait_until_asset_model_active(&self) -> AssetModelActiveFluentBuilder

Wait for asset_model_active

fn wait_until_asset_model_not_exists(&self) -> AssetModelNotExistsFluentBuilder

Wait for asset_model_not_exists

fn wait_until_portal_active(&self) -> PortalActiveFluentBuilder

Wait for portal_active

fn wait_until_portal_not_exists(&self) -> PortalNotExistsFluentBuilder

Wait for portal_not_exists