GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::IoTSiteWise(3) User Contributed Perl Documentation Paws::IoTSiteWise(3)

Paws::IoTSiteWise - Perl Interface to AWS AWS IoT SiteWise

  use Paws;
  my $obj = Paws->service('IoTSiteWise');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

Welcome to the AWS IoT SiteWise API Reference. AWS IoT SiteWise is an AWS service that connects Industrial Internet of Things (IIoT) (https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications) devices to the power of the AWS Cloud. For more information, see the AWS IoT SiteWise User Guide (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/). For information about AWS IoT SiteWise quotas, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the AWS IoT SiteWise User Guide.

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02>

[ClientToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::AssociateAssets

Returns: nothing

Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html) in the AWS IoT SiteWise User Guide.

[ClientToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::BatchAssociateProjectAssets

Returns: a Paws::IoTSiteWise::BatchAssociateProjectAssetsResponse instance

Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.

[ClientToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::BatchDisassociateProjectAssets

Returns: a Paws::IoTSiteWise::BatchDisassociateProjectAssetsResponse instance

Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.

Each argument is described in detail in: Paws::IoTSiteWise::BatchPutAssetPropertyValue

Returns: a Paws::IoTSiteWise::BatchPutAssetPropertyValueResponse instance

Sends a list of asset property values to AWS IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html) in the AWS IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

  • The "assetId" and "propertyId" of an asset property.
  • A "propertyAlias", which is a data stream alias (for example, "/company/windfarm/3/turbine/7/temperature"). To define an asset property's alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html).

With respect to Unix epoch time, AWS IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. AWS IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 minutes] and returns a "TimestampOutOfRangeException" error.

For each asset property, AWS IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV "{T1, GOOD, V1}", then storing "{T1, GOOD, V2}" replaces the existing TQV.

AWS IoT SiteWise authorizes access to each "BatchPutAssetPropertyValue" entry individually. For more information, see BatchPutAssetPropertyValue authorization (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-batchputassetpropertyvalue-action) in the AWS IoT SiteWise User Guide.

[ClientToken => Str]
[Tags => Paws::IoTSiteWise::TagMap]

Each argument is described in detail in: Paws::IoTSiteWise::CreateAccessPolicy

Returns: a Paws::IoTSiteWise::CreateAccessPolicyResponse instance

Creates an access policy that grants the specified identity (AWS SSO user, AWS SSO group, or IAM user) access to the specified AWS IoT SiteWise Monitor portal or project resource.

[ClientToken => Str]
[Tags => Paws::IoTSiteWise::TagMap]

Each argument is described in detail in: Paws::IoTSiteWise::CreateAsset

Returns: a Paws::IoTSiteWise::CreateAssetResponse instance

Creates an asset from an existing asset model. For more information, see Creating assets (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html) in the AWS IoT SiteWise User Guide.

[AssetModelCompositeModels => ArrayRef[Paws::IoTSiteWise::AssetModelCompositeModelDefinition]]
[AssetModelDescription => Str]
[AssetModelHierarchies => ArrayRef[Paws::IoTSiteWise::AssetModelHierarchyDefinition]]
[AssetModelProperties => ArrayRef[Paws::IoTSiteWise::AssetModelPropertyDefinition]]
[ClientToken => Str]
[Tags => Paws::IoTSiteWise::TagMap]

Each argument is described in detail in: Paws::IoTSiteWise::CreateAssetModel

Returns: a Paws::IoTSiteWise::CreateAssetModelResponse instance

Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html) in the AWS IoT SiteWise User Guide.

[ClientToken => Str]
[DashboardDescription => Str]
[Tags => Paws::IoTSiteWise::TagMap]

Each argument is described in detail in: Paws::IoTSiteWise::CreateDashboard

Returns: a Paws::IoTSiteWise::CreateDashboardResponse instance

Creates a dashboard in an AWS IoT SiteWise Monitor project.

[Tags => Paws::IoTSiteWise::TagMap]

Each argument is described in detail in: Paws::IoTSiteWise::CreateGateway

Returns: a Paws::IoTSiteWise::CreateGatewayResponse instance

Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise. For more information, see Ingesting data using a gateway (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html) in the AWS IoT SiteWise User Guide.

[Alarms => Paws::IoTSiteWise::Alarms]
[ClientToken => Str]
[NotificationSenderEmail => Str]
[PortalAuthMode => Str]
[PortalDescription => Str]
[PortalLogoImageFile => Paws::IoTSiteWise::ImageFile]
[Tags => Paws::IoTSiteWise::TagMap]

Each argument is described in detail in: Paws::IoTSiteWise::CreatePortal

Returns: a Paws::IoTSiteWise::CreatePortalResponse instance

Creates a portal, which can contain projects and dashboards. AWS IoT SiteWise Monitor uses AWS SSO or IAM to authenticate portal users and manage user permissions.

Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) in the AWS IoT SiteWise User Guide.

[ClientToken => Str]
[ProjectDescription => Str]
[Tags => Paws::IoTSiteWise::TagMap]

Each argument is described in detail in: Paws::IoTSiteWise::CreateProject

Returns: a Paws::IoTSiteWise::CreateProjectResponse instance

Creates a project in the specified portal.

[ClientToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::DeleteAccessPolicy

Returns: a Paws::IoTSiteWise::DeleteAccessPolicyResponse instance

Deletes an access policy that grants the specified identity access to the specified AWS IoT SiteWise Monitor resource. You can use this operation to revoke access to an AWS IoT SiteWise Monitor resource.

[ClientToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::DeleteAsset

Returns: a Paws::IoTSiteWise::DeleteAssetResponse instance

Deletes an asset. This action can't be undone. For more information, see Deleting assets and models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html) in the AWS IoT SiteWise User Guide.

You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DisassociateAssets.html).

[ClientToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::DeleteAssetModel

Returns: a Paws::IoTSiteWise::DeleteAssetModelResponse instance

Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html) in the AWS IoT SiteWise User Guide.

[ClientToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::DeleteDashboard

Returns: a Paws::IoTSiteWise::DeleteDashboardResponse instance

Deletes a dashboard from AWS IoT SiteWise Monitor.

Each argument is described in detail in: Paws::IoTSiteWise::DeleteGateway

Returns: nothing

Deletes a gateway from AWS IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.

[ClientToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::DeletePortal

Returns: a Paws::IoTSiteWise::DeletePortalResponse instance

Deletes a portal from AWS IoT SiteWise Monitor.

[ClientToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::DeleteProject

Returns: a Paws::IoTSiteWise::DeleteProjectResponse instance

Deletes a project from AWS IoT SiteWise Monitor.

Each argument is described in detail in: Paws::IoTSiteWise::DescribeAccessPolicy

Returns: a Paws::IoTSiteWise::DescribeAccessPolicyResponse instance

Describes an access policy, which specifies an identity's access to an AWS IoT SiteWise Monitor portal or project.

Each argument is described in detail in: Paws::IoTSiteWise::DescribeAsset

Returns: a Paws::IoTSiteWise::DescribeAssetResponse instance

Retrieves information about an asset.

Each argument is described in detail in: Paws::IoTSiteWise::DescribeAssetModel

Returns: a Paws::IoTSiteWise::DescribeAssetModelResponse instance

Retrieves information about an asset model.

Each argument is described in detail in: Paws::IoTSiteWise::DescribeAssetProperty

Returns: a Paws::IoTSiteWise::DescribeAssetPropertyResponse instance

Retrieves information about an asset property.

When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.

This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_GetAssetPropertyValue.html).

Each argument is described in detail in: Paws::IoTSiteWise::DescribeDashboard

Returns: a Paws::IoTSiteWise::DescribeDashboardResponse instance

Retrieves information about a dashboard.

Each argument is described in detail in: Paws::IoTSiteWise::DescribeDefaultEncryptionConfiguration

Returns: a Paws::IoTSiteWise::DescribeDefaultEncryptionConfigurationResponse instance

Retrieves information about the default encryption configuration for the AWS account in the default or specified region. For more information, see Key management (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html) in the AWS IoT SiteWise User Guide.

Each argument is described in detail in: Paws::IoTSiteWise::DescribeGateway

Returns: a Paws::IoTSiteWise::DescribeGatewayResponse instance

Retrieves information about a gateway.

Each argument is described in detail in: Paws::IoTSiteWise::DescribeGatewayCapabilityConfiguration

Returns: a Paws::IoTSiteWise::DescribeGatewayCapabilityConfigurationResponse instance

Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the AWS IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html).

Each argument is described in detail in: Paws::IoTSiteWise::DescribeLoggingOptions

Returns: a Paws::IoTSiteWise::DescribeLoggingOptionsResponse instance

Retrieves the current AWS IoT SiteWise logging options.

Each argument is described in detail in: Paws::IoTSiteWise::DescribePortal

Returns: a Paws::IoTSiteWise::DescribePortalResponse instance

Retrieves information about a portal.

Each argument is described in detail in: Paws::IoTSiteWise::DescribeProject

Returns: a Paws::IoTSiteWise::DescribeProjectResponse instance

Retrieves information about a project.

[ClientToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::DisassociateAssets

Returns: nothing

Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.

[AssetId => Str]
[MaxResults => Int]
[NextToken => Str]
[PropertyAlias => Str]
[PropertyId => Str]
[Qualities => ArrayRef[Str|Undef]]
[TimeOrdering => Str]

Each argument is described in detail in: Paws::IoTSiteWise::GetAssetPropertyAggregates

Returns: a Paws::IoTSiteWise::GetAssetPropertyAggregatesResponse instance

Gets aggregated values for an asset property. For more information, see Querying aggregates (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates) in the AWS IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

  • The "assetId" and "propertyId" of an asset property.
  • A "propertyAlias", which is a data stream alias (for example, "/company/windfarm/3/turbine/7/temperature"). To define an asset property's alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html).

[AssetId => Str]
[PropertyAlias => Str]
[PropertyId => Str]

Each argument is described in detail in: Paws::IoTSiteWise::GetAssetPropertyValue

Returns: a Paws::IoTSiteWise::GetAssetPropertyValueResponse instance

Gets an asset property's current value. For more information, see Querying current values (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values) in the AWS IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

  • The "assetId" and "propertyId" of an asset property.
  • A "propertyAlias", which is a data stream alias (for example, "/company/windfarm/3/turbine/7/temperature"). To define an asset property's alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html).

[AssetId => Str]
[EndDate => Str]
[MaxResults => Int]
[NextToken => Str]
[PropertyAlias => Str]
[PropertyId => Str]
[Qualities => ArrayRef[Str|Undef]]
[StartDate => Str]
[TimeOrdering => Str]

Each argument is described in detail in: Paws::IoTSiteWise::GetAssetPropertyValueHistory

Returns: a Paws::IoTSiteWise::GetAssetPropertyValueHistoryResponse instance

Gets the history of an asset property's values. For more information, see Querying historical values (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values) in the AWS IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

  • The "assetId" and "propertyId" of an asset property.
  • A "propertyAlias", which is a data stream alias (for example, "/company/windfarm/3/turbine/7/temperature"). To define an asset property's alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html).

[AssetId => Str]
[EndTimeOffsetInNanos => Int]
[MaxResults => Int]
[NextToken => Str]
[PropertyAlias => Str]
[PropertyId => Str]
[StartTimeOffsetInNanos => Int]

Each argument is described in detail in: Paws::IoTSiteWise::GetInterpolatedAssetPropertyValues

Returns: a Paws::IoTSiteWise::GetInterpolatedAssetPropertyValuesResponse instance

Get interpolated values for an asset property for a specified time interval, during a period of time. For example, you can use the this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.

This API isn't available in China (Beijing).

To identify an asset property, you must specify one of the following:

  • The "assetId" and "propertyId" of an asset property.
  • A "propertyAlias", which is a data stream alias (for example, "/company/windfarm/3/turbine/7/temperature"). To define an asset property's alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html).

[IamArn => Str]
[IdentityId => Str]
[IdentityType => Str]
[MaxResults => Int]
[NextToken => Str]
[ResourceId => Str]
[ResourceType => Str]

Each argument is described in detail in: Paws::IoTSiteWise::ListAccessPolicies

Returns: a Paws::IoTSiteWise::ListAccessPoliciesResponse instance

Retrieves a paginated list of access policies for an identity (an AWS SSO user, an AWS SSO group, or an IAM user) or an AWS IoT SiteWise Monitor resource (a portal or project).

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::ListAssetModels

Returns: a Paws::IoTSiteWise::ListAssetModelsResponse instance

Retrieves a paginated list of summaries of all asset models.

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::ListAssetRelationships

Returns: a Paws::IoTSiteWise::ListAssetRelationshipsResponse instance

Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.

[AssetModelId => Str]
[Filter => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::ListAssets

Returns: a Paws::IoTSiteWise::ListAssetsResponse instance

Retrieves a paginated list of asset summaries.

You can use this operation to do the following:

  • List assets based on a specific asset model.
  • List top-level assets.

You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssetModels.html) to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.

[HierarchyId => Str]
[MaxResults => Int]
[NextToken => Str]
[TraversalDirection => Str]

Each argument is described in detail in: Paws::IoTSiteWise::ListAssociatedAssets

Returns: a Paws::IoTSiteWise::ListAssociatedAssetsResponse instance

Retrieves a paginated list of associated assets.

You can use this operation to do the following:

  • List child assets associated to a parent asset by a hierarchy that you specify.
  • List an asset's parent asset.

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::ListDashboards

Returns: a Paws::IoTSiteWise::ListDashboardsResponse instance

Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::ListGateways

Returns: a Paws::IoTSiteWise::ListGatewaysResponse instance

Retrieves a paginated list of gateways.

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::ListPortals

Returns: a Paws::IoTSiteWise::ListPortalsResponse instance

Retrieves a paginated list of AWS IoT SiteWise Monitor portals.

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::ListProjectAssets

Returns: a Paws::IoTSiteWise::ListProjectAssetsResponse instance

Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::ListProjects

Returns: a Paws::IoTSiteWise::ListProjectsResponse instance

Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.

Each argument is described in detail in: Paws::IoTSiteWise::ListTagsForResource

Returns: a Paws::IoTSiteWise::ListTagsForResourceResponse instance

Retrieves the list of tags for an AWS IoT SiteWise resource.

[KmsKeyId => Str]

Each argument is described in detail in: Paws::IoTSiteWise::PutDefaultEncryptionConfiguration

Returns: a Paws::IoTSiteWise::PutDefaultEncryptionConfigurationResponse instance

Sets the default encryption configuration for the AWS account. For more information, see Key management (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html) in the AWS IoT SiteWise User Guide.

Each argument is described in detail in: Paws::IoTSiteWise::PutLoggingOptions

Returns: a Paws::IoTSiteWise::PutLoggingOptionsResponse instance

Sets logging options for AWS IoT SiteWise.

Each argument is described in detail in: Paws::IoTSiteWise::TagResource

Returns: a Paws::IoTSiteWise::TagResourceResponse instance

Adds tags to an AWS IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.

Each argument is described in detail in: Paws::IoTSiteWise::UntagResource

Returns: a Paws::IoTSiteWise::UntagResourceResponse instance

Removes a tag from an AWS IoT SiteWise resource.

[ClientToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::UpdateAccessPolicy

Returns: a Paws::IoTSiteWise::UpdateAccessPolicyResponse instance

Updates an existing access policy that specifies an identity's access to an AWS IoT SiteWise Monitor portal or project resource.

[ClientToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::UpdateAsset

Returns: a Paws::IoTSiteWise::UpdateAssetResponse instance

Updates an asset's name. For more information, see Updating assets and models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html) in the AWS IoT SiteWise User Guide.

[AssetModelCompositeModels => ArrayRef[Paws::IoTSiteWise::AssetModelCompositeModel]]
[AssetModelDescription => Str]
[AssetModelHierarchies => ArrayRef[Paws::IoTSiteWise::AssetModelHierarchy]]
[AssetModelProperties => ArrayRef[Paws::IoTSiteWise::AssetModelProperty]]
[ClientToken => Str]

Each argument is described in detail in: Paws::IoTSiteWise::UpdateAssetModel

Returns: a Paws::IoTSiteWise::UpdateAssetModelResponse instance

Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html) in the AWS IoT SiteWise User Guide.

This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html).

If you remove a property from an asset model, AWS IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, AWS IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.

[ClientToken => Str]
[PropertyAlias => Str]
[PropertyNotificationState => Str]

Each argument is described in detail in: Paws::IoTSiteWise::UpdateAssetProperty

Returns: nothing

Updates an asset property's alias and notification state.

This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetProperty.html).

[ClientToken => Str]
[DashboardDescription => Str]

Each argument is described in detail in: Paws::IoTSiteWise::UpdateDashboard

Returns: a Paws::IoTSiteWise::UpdateDashboardResponse instance

Updates an AWS IoT SiteWise Monitor dashboard.

Each argument is described in detail in: Paws::IoTSiteWise::UpdateGateway

Returns: nothing

Updates a gateway's name.

Each argument is described in detail in: Paws::IoTSiteWise::UpdateGatewayCapabilityConfiguration

Returns: a Paws::IoTSiteWise::UpdateGatewayCapabilityConfigurationResponse instance

Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the AWS IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html).

[Alarms => Paws::IoTSiteWise::Alarms]
[ClientToken => Str]
[NotificationSenderEmail => Str]
[PortalDescription => Str]
[PortalLogoImage => Paws::IoTSiteWise::Image]

Each argument is described in detail in: Paws::IoTSiteWise::UpdatePortal

Returns: a Paws::IoTSiteWise::UpdatePortalResponse instance

Updates an AWS IoT SiteWise Monitor portal.

[ClientToken => Str]
[ProjectDescription => Str]

Each argument is described in detail in: Paws::IoTSiteWise::UpdateProject

Returns: a Paws::IoTSiteWise::UpdateProjectResponse instance

Updates an AWS IoT SiteWise Monitor project.

Paginator methods are helpers that repetively call methods that return partial results

If passed a sub as first parameter, it will call the sub for each element found in :

 - aggregatedValues, passing the object as the first parameter, and the string 'aggregatedValues' as the second parameter

If not, it will return a a Paws::IoTSiteWise::GetAssetPropertyAggregatesResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - assetPropertyValueHistory, passing the object as the first parameter, and the string 'assetPropertyValueHistory' as the second parameter

If not, it will return a a Paws::IoTSiteWise::GetAssetPropertyValueHistoryResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - interpolatedAssetPropertyValues, passing the object as the first parameter, and the string 'interpolatedAssetPropertyValues' as the second parameter

If not, it will return a a Paws::IoTSiteWise::GetInterpolatedAssetPropertyValuesResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - accessPolicySummaries, passing the object as the first parameter, and the string 'accessPolicySummaries' as the second parameter

If not, it will return a a Paws::IoTSiteWise::ListAccessPoliciesResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - assetModelSummaries, passing the object as the first parameter, and the string 'assetModelSummaries' as the second parameter

If not, it will return a a Paws::IoTSiteWise::ListAssetModelsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - assetRelationshipSummaries, passing the object as the first parameter, and the string 'assetRelationshipSummaries' as the second parameter

If not, it will return a a Paws::IoTSiteWise::ListAssetRelationshipsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - assetSummaries, passing the object as the first parameter, and the string 'assetSummaries' as the second parameter

If not, it will return a a Paws::IoTSiteWise::ListAssetsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - assetSummaries, passing the object as the first parameter, and the string 'assetSummaries' as the second parameter

If not, it will return a a Paws::IoTSiteWise::ListAssociatedAssetsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - dashboardSummaries, passing the object as the first parameter, and the string 'dashboardSummaries' as the second parameter

If not, it will return a a Paws::IoTSiteWise::ListDashboardsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - gatewaySummaries, passing the object as the first parameter, and the string 'gatewaySummaries' as the second parameter

If not, it will return a a Paws::IoTSiteWise::ListGatewaysResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - portalSummaries, passing the object as the first parameter, and the string 'portalSummaries' as the second parameter

If not, it will return a a Paws::IoTSiteWise::ListPortalsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - assetIds, passing the object as the first parameter, and the string 'assetIds' as the second parameter

If not, it will return a a Paws::IoTSiteWise::ListProjectAssetsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - projectSummaries, passing the object as the first parameter, and the string 'projectSummaries' as the second parameter

If not, it will return a a Paws::IoTSiteWise::ListProjectsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

This service class forms part of Paws

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2
Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.