5.0.0 • Published 5 years ago

@datafire/amazonaws_iotsitewise v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/amazonaws_iotsitewise

Client library for AWS IoT SiteWise

Installation and Usage

npm install --save @datafire/amazonaws_iotsitewise
let amazonaws_iotsitewise = require('@datafire/amazonaws_iotsitewise').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Welcome to the AWS IoT SiteWise API Reference. AWS IoT SiteWise is an AWS service that connects Industrial Internet of Things (IIoT) devices to the power of the AWS Cloud. For more information, see the AWS IoT SiteWise User Guide. For information about AWS IoT SiteWise quotas, see Quotas in the AWS IoT SiteWise User Guide.

Actions

ListGateways

amazonaws_iotsitewise.ListGateways({}, context)

Input

  • input object
    • nextToken string
    • maxResults integer

Output

CreateGateway

amazonaws_iotsitewise.CreateGateway({
  "gatewayName": "",
  "gatewayPlatform": {}
}, context)

Input

  • input object
    • tags object: A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
    • gatewayName required string: A unique, friendly name for the gateway.
    • gatewayPlatform required object: Contains a gateway's platform information.
      • greengrass
        • groupArn required

Output

Output schema unknown

DeleteGateway

amazonaws_iotsitewise.DeleteGateway({
  "gatewayId": ""
}, context)

Input

  • input object
    • gatewayId required string

Output

Output schema unknown

DescribeGateway

amazonaws_iotsitewise.DescribeGateway({
  "gatewayId": ""
}, context)

Input

  • input object
    • gatewayId required string

Output

UpdateGateway

amazonaws_iotsitewise.UpdateGateway({
  "gatewayId": "",
  "gatewayName": ""
}, context)

Input

  • input object
    • gatewayId required string
    • gatewayName required string: A unique, friendly name for the gateway.

Output

Output schema unknown

UpdateGatewayCapabilityConfiguration

amazonaws_iotsitewise.UpdateGatewayCapabilityConfiguration({
  "gatewayId": "",
  "capabilityNamespace": "",
  "capabilityConfiguration": ""
}, context)

Input

  • input object
    • gatewayId required string
    • capabilityConfiguration required string: The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide.
    • capabilityNamespace required string: The namespace of the gateway capability configuration to be updated. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.

Output

Output schema unknown

DescribeGatewayCapabilityConfiguration

amazonaws_iotsitewise.DescribeGatewayCapabilityConfiguration({
  "gatewayId": "",
  "capabilityNamespace": ""
}, context)

Input

  • input object
    • gatewayId required string
    • capabilityNamespace required string

Output

ListAccessPolicies

amazonaws_iotsitewise.ListAccessPolicies({}, context)

Input

  • input object
    • identityType string
    • identityId string
    • resourceType string
    • resourceId string
    • iamArn string
    • nextToken string
    • maxResults integer

Output

CreateAccessPolicy

amazonaws_iotsitewise.CreateAccessPolicy({
  "accessPolicyIdentity": {},
  "accessPolicyResource": {},
  "accessPolicyPermission": ""
}, context)

Input

  • input object
    • tags object: A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
    • accessPolicyIdentity required object: Contains an identity that can access an AWS IoT SiteWise Monitor resource. Currently, you can't use AWS APIs to retrieve AWS SSO identity IDs. You can find the AWS SSO identity IDs in the URL of user and group pages in the AWS SSO console.
      • group
        • id required
      • iamUser
        • arn required
      • user
        • id required
    • accessPolicyPermission required string (values: ADMINISTRATOR, VIEWER): The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.
    • accessPolicyResource required object: Contains an AWS IoT SiteWise Monitor resource ID for a portal or project.
      • portal
        • id required
      • project
        • id required
    • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Output

Output schema unknown

DeleteAccessPolicy

amazonaws_iotsitewise.DeleteAccessPolicy({
  "accessPolicyId": ""
}, context)

Input

  • input object
    • accessPolicyId required string
    • clientToken string

Output

Output schema unknown

DescribeAccessPolicy

amazonaws_iotsitewise.DescribeAccessPolicy({
  "accessPolicyId": ""
}, context)

Input

  • input object
    • accessPolicyId required string

Output

UpdateAccessPolicy

amazonaws_iotsitewise.UpdateAccessPolicy({
  "accessPolicyId": "",
  "accessPolicyIdentity": {},
  "accessPolicyResource": {},
  "accessPolicyPermission": ""
}, context)

Input

  • input object
    • accessPolicyId required string
    • accessPolicyIdentity required object: Contains an identity that can access an AWS IoT SiteWise Monitor resource. Currently, you can't use AWS APIs to retrieve AWS SSO identity IDs. You can find the AWS SSO identity IDs in the URL of user and group pages in the AWS SSO console.
      • group
        • id required
      • iamUser
        • arn required
      • user
        • id required
    • accessPolicyPermission required string (values: ADMINISTRATOR, VIEWER): The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.
    • accessPolicyResource required object: Contains an AWS IoT SiteWise Monitor resource ID for a portal or project.
      • portal
        • id required
      • project
        • id required
    • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Output

ListAssetModels

amazonaws_iotsitewise.ListAssetModels({}, context)

Input

  • input object
    • nextToken string
    • maxResults integer

Output

CreateAssetModel

amazonaws_iotsitewise.CreateAssetModel({
  "assetModelName": ""
}, context)

Input

  • input object
    • tags object: A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
    • assetModelCompositeModels array: The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.
    • assetModelDescription string: A description for the asset model.
    • assetModelHierarchies array: 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 AWS IoT SiteWise User Guide. You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
    • assetModelName required string: A unique, friendly name for the asset model.
    • assetModelProperties array: The property definitions of the asset model. For more information, see Asset properties in the AWS IoT SiteWise User Guide. You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
    • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Output

Output schema unknown

DeleteAssetModel

amazonaws_iotsitewise.DeleteAssetModel({
  "assetModelId": ""
}, context)

Input

  • input object
    • assetModelId required string
    • clientToken string

Output

Output schema unknown

DescribeAssetModel

amazonaws_iotsitewise.DescribeAssetModel({
  "assetModelId": ""
}, context)

Input

  • input object
    • assetModelId required string

Output

UpdateAssetModel

amazonaws_iotsitewise.UpdateAssetModel({
  "assetModelId": "",
  "assetModelName": ""
}, context)

Input

  • input object
    • assetModelId required string
    • assetModelCompositeModels array: The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.
    • assetModelDescription string: A description for the asset model.
    • assetModelHierarchies array: 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 AWS IoT SiteWise User Guide. You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
    • assetModelName required string: A unique, friendly name for the asset model.
    • assetModelProperties array: The updated property definitions of the asset model. For more information, see Asset properties in the AWS IoT SiteWise User Guide. You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
    • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Output

Output schema unknown

ListAssets

amazonaws_iotsitewise.ListAssets({}, context)

Input

  • input object
    • nextToken string
    • maxResults integer
    • assetModelId string
    • filter string

Output

CreateAsset

amazonaws_iotsitewise.CreateAsset({
  "assetName": "",
  "assetModelId": ""
}, context)

Input

  • input object
    • tags object: A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
    • assetModelId required string: The ID of the asset model from which to create the asset.
    • assetName required string: A unique, friendly name for the asset.
    • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Output

Output schema unknown

DeleteAsset

amazonaws_iotsitewise.DeleteAsset({
  "assetId": ""
}, context)

Input

  • input object
    • assetId required string
    • clientToken string

Output

Output schema unknown

DescribeAsset

amazonaws_iotsitewise.DescribeAsset({
  "assetId": ""
}, context)

Input

  • input object
    • assetId required string

Output

UpdateAsset

amazonaws_iotsitewise.UpdateAsset({
  "assetId": "",
  "assetName": ""
}, context)

Input

  • input object
    • assetId required string
    • assetName required string: A unique, friendly name for the asset.
    • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Output

Output schema unknown

ListAssetRelationships

amazonaws_iotsitewise.ListAssetRelationships({
  "assetId": "",
  "traversalType": ""
}, context)

Input

  • input object
    • assetId required string
    • traversalType required string
    • nextToken string
    • maxResults integer

Output

AssociateAssets

amazonaws_iotsitewise.AssociateAssets({
  "assetId": "",
  "hierarchyId": "",
  "childAssetId": ""
}, context)

Input

  • input object
    • assetId required string
    • childAssetId required string: The ID of the child asset to be associated.
    • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
    • hierarchyId required string: The ID of a hierarchy in the parent asset's model. 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 AWS IoT SiteWise User Guide.

Output

Output schema unknown

DisassociateAssets

amazonaws_iotsitewise.DisassociateAssets({
  "assetId": "",
  "hierarchyId": "",
  "childAssetId": ""
}, context)

Input

  • input object
    • assetId required string
    • childAssetId required string: The ID of the child asset to disassociate.
    • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
    • hierarchyId required string: The ID of a hierarchy in the parent asset's model. 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 AWS IoT SiteWise User Guide.

Output

Output schema unknown

ListAssociatedAssets

amazonaws_iotsitewise.ListAssociatedAssets({
  "assetId": ""
}, context)

Input

  • input object
    • assetId required string
    • hierarchyId string
    • traversalDirection string
    • nextToken string
    • maxResults integer

Output

DescribeAssetProperty

amazonaws_iotsitewise.DescribeAssetProperty({
  "assetId": "",
  "propertyId": ""
}, context)

Input

  • input object
    • assetId required string
    • propertyId required string

Output

UpdateAssetProperty

amazonaws_iotsitewise.UpdateAssetProperty({
  "assetId": "",
  "propertyId": ""
}, context)

Input

  • input object
    • assetId required string
    • propertyId required string
    • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
    • propertyAlias string: The property 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 AWS IoT SiteWise User Guide. If you omit this parameter, the alias is removed from the property.
    • propertyNotificationState string (values: ENABLED, DISABLED): The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the AWS IoT SiteWise User Guide. If you omit this parameter, the notification state is set to DISABLED.

Output

Output schema unknown

DescribeDefaultEncryptionConfiguration

amazonaws_iotsitewise.DescribeDefaultEncryptionConfiguration({}, context)

Input

  • input object

Output

PutDefaultEncryptionConfiguration

amazonaws_iotsitewise.PutDefaultEncryptionConfiguration({
  "encryptionType": ""
}, context)

Input

  • input object
    • encryptionType required string (values: SITEWISE_DEFAULT_ENCRYPTION, KMS_BASED_ENCRYPTION): The type of encryption used for the encryption configuration.
    • kmsKeyId string: The Key ID of the customer managed customer master key (CMK) used for AWS KMS encryption. This is required if you use KMS_BASED_ENCRYPTION.

Output

CreateDashboard

amazonaws_iotsitewise.CreateDashboard({
  "projectId": "",
  "dashboardName": "",
  "dashboardDefinition": ""
}, context)

Input

  • input object
    • tags object: A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
    • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
    • dashboardDefinition required string: The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.
    • dashboardDescription string: A description for the dashboard.
    • dashboardName required string: A friendly name for the dashboard.
    • projectId required string: The ID of the project in which to create the dashboard.

Output

Output schema unknown

ListDashboards

amazonaws_iotsitewise.ListDashboards({
  "projectId": ""
}, context)

Input

  • input object
    • projectId required string
    • nextToken string
    • maxResults integer

Output

DeleteDashboard

amazonaws_iotsitewise.DeleteDashboard({
  "dashboardId": ""
}, context)

Input

  • input object
    • dashboardId required string
    • clientToken string

Output

Output schema unknown

DescribeDashboard

amazonaws_iotsitewise.DescribeDashboard({
  "dashboardId": ""
}, context)

Input

  • input object
    • dashboardId required string

Output

UpdateDashboard

amazonaws_iotsitewise.UpdateDashboard({
  "dashboardId": "",
  "dashboardName": "",
  "dashboardDefinition": ""
}, context)

Input

  • input object
    • dashboardId required string
    • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
    • dashboardDefinition required string: The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.
    • dashboardDescription string: A new description for the dashboard.
    • dashboardName required string: A new friendly name for the dashboard.

Output

DescribeLoggingOptions

amazonaws_iotsitewise.DescribeLoggingOptions({}, context)

Input

  • input object

Output

PutLoggingOptions

amazonaws_iotsitewise.PutLoggingOptions({
  "loggingOptions": {}
}, context)

Input

  • input object
    • loggingOptions required object: Contains logging options.
      • level

Output

ListPortals

amazonaws_iotsitewise.ListPortals({}, context)

Input

  • input object
    • nextToken string
    • maxResults integer

Output

CreatePortal

amazonaws_iotsitewise.CreatePortal({
  "portalName": "",
  "portalContactEmail": "",
  "roleArn": ""
}, context)

Input

  • input object
    • tags object: A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
    • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
    • portalAuthMode string (values: IAM, SSO): The service to use to authenticate users to the portal. Choose from the following options: SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide. This option is only available in AWS Regions other than the China Regions. IAM – The portal uses AWS Identity and Access Management (IAM) to authenticate users and manage user permissions. This option is only available in the China Regions. You can't change this value after you create a portal. Default: SSO
    • portalContactEmail required string: The AWS administrator's contact email address.
    • portalDescription string: A description for the portal.
    • portalLogoImageFile object: Contains an image file.
      • data
      • type
    • portalName required string: A friendly name for the portal.
    • roleArn required string: The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.

Output

Output schema unknown

DeletePortal

amazonaws_iotsitewise.DeletePortal({
  "portalId": ""
}, context)

Input

  • input object
    • portalId required string
    • clientToken string

Output

Output schema unknown

DescribePortal

amazonaws_iotsitewise.DescribePortal({
  "portalId": ""
}, context)

Input

  • input object
    • portalId required string

Output

UpdatePortal

amazonaws_iotsitewise.UpdatePortal({
  "portalId": "",
  "portalName": "",
  "portalContactEmail": "",
  "roleArn": ""
}, context)

Input

  • input object
    • portalId required string
    • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
    • portalContactEmail required string: The AWS administrator's contact email address.
    • portalDescription string: A new description for the portal.
    • portalLogoImage object: 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.
    • portalName required string: A new friendly name for the portal.
    • roleArn required string: The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.

Output

Output schema unknown

CreateProject

amazonaws_iotsitewise.CreateProject({
  "portalId": "",
  "projectName": ""
}, context)

Input

  • input object
    • tags object: A list of key-value pairs that contain metadata for the project. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
    • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
    • portalId required string: The ID of the portal in which to create the project.
    • projectDescription string: A description for the project.
    • projectName required string: A friendly name for the project.

Output

Output schema unknown

ListProjects

amazonaws_iotsitewise.ListProjects({
  "portalId": ""
}, context)

Input

  • input object
    • portalId required string
    • nextToken string
    • maxResults integer

Output

DeleteProject

amazonaws_iotsitewise.DeleteProject({
  "projectId": ""
}, context)

Input

  • input object
    • projectId required string
    • clientToken string

Output

Output schema unknown

DescribeProject

amazonaws_iotsitewise.DescribeProject({
  "projectId": ""
}, context)

Input

  • input object
    • projectId required string

Output

UpdateProject

amazonaws_iotsitewise.UpdateProject({
  "projectId": "",
  "projectName": ""
}, context)

Input

  • input object
    • projectId required string
    • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
    • projectDescription string: A new description for the project.
    • projectName required string: A new friendly name for the project.

Output

ListProjectAssets

amazonaws_iotsitewise.ListProjectAssets({
  "projectId": ""
}, context)

Input

  • input object
    • projectId required string
    • nextToken string
    • maxResults integer

Output

BatchAssociateProjectAssets

amazonaws_iotsitewise.BatchAssociateProjectAssets({
  "projectId": "",
  "assetIds": []
}, context)

Input

  • input object
    • projectId required string
    • assetIds required array: The IDs of the assets to be associated to the project.
    • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Output

BatchDisassociateProjectAssets

amazonaws_iotsitewise.BatchDisassociateProjectAssets({
  "projectId": "",
  "assetIds": []
}, context)

Input

  • input object
    • projectId required string
    • assetIds required array: The IDs of the assets to be disassociated from the project.
    • clientToken string: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Output

BatchPutAssetPropertyValue

amazonaws_iotsitewise.BatchPutAssetPropertyValue({
  "entries": []
}, context)

Input

  • input object
    • entries required array: The list of asset property value entries for the batch put request. You can specify up to 10 entries per request.

Output

GetAssetPropertyAggregates

amazonaws_iotsitewise.GetAssetPropertyAggregates({
  "aggregateTypes": [],
  "resolution": "",
  "startDate": "",
  "endDate": ""
}, context)

Input

  • input object
    • assetId string
    • propertyId string
    • propertyAlias string
    • aggregateTypes required array
    • resolution required string
    • qualities array
    • startDate required string
    • endDate required string
    • timeOrdering string
    • nextToken string
    • maxResults integer

Output

GetAssetPropertyValueHistory

amazonaws_iotsitewise.GetAssetPropertyValueHistory({}, context)

Input

  • input object
    • assetId string
    • propertyId string
    • propertyAlias string
    • startDate string
    • endDate string
    • qualities array
    • timeOrdering string
    • nextToken string
    • maxResults integer

Output

GetAssetPropertyValue

amazonaws_iotsitewise.GetAssetPropertyValue({}, context)

Input

  • input object
    • assetId string
    • propertyId string
    • propertyAlias string

Output

ListTagsForResource

amazonaws_iotsitewise.ListTagsForResource({
  "resourceArn": ""
}, context)

Input

  • input object
    • resourceArn required string

Output

TagResource

amazonaws_iotsitewise.TagResource({
  "resourceArn": "",
  "tags": {}
}, context)

Input

  • input object
    • resourceArn required string
    • tags required object: A list of key-value pairs that contain metadata for the resource. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

Output

UntagResource

amazonaws_iotsitewise.UntagResource({
  "resourceArn": "",
  "tagKeys": []
}, context)

Input

  • input object
    • resourceArn required string
    • tagKeys required array

Output

Definitions

ARN

  • ARN string

AccessPolicySummaries

AccessPolicySummary

  • AccessPolicySummary object: Contains an access policy that defines an identity's access to an AWS IoT SiteWise Monitor resource.
    • creationDate
    • id required
    • identity required
      • group
        • id required
      • iamUser
        • arn required
      • user
        • id required
    • lastUpdateDate
    • permission required
    • resource required
      • portal
        • id required
      • project
        • id required

AggregateType

  • AggregateType string (values: AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION)

AggregateTypes

AggregatedDoubleValue

  • AggregatedDoubleValue number

AggregatedValue

  • AggregatedValue object: Contains aggregated asset property values (for example, average, minimum, and maximum).
    • quality
    • timestamp required
    • value required
      • average
      • count
      • maximum
      • minimum
      • standardDeviation
      • sum

AggregatedValues

Aggregates

  • Aggregates object: Contains the (pre-calculated) aggregate values for an asset property.
    • average
    • count
    • maximum
    • minimum
    • standardDeviation
    • sum

AmazonResourceName

  • AmazonResourceName string

AssetCompositeModel

  • AssetCompositeModel object: Contains information about a composite model in an asset. This object contains the asset's properties that you define in the composite model.
    • description
    • name required
    • properties required
    • type required

AssetCompositeModels

AssetErrorCode

  • AssetErrorCode string (values: INTERNAL_FAILURE)

AssetErrorDetails

  • AssetErrorDetails object: Contains error details for the requested associate project asset action.
    • assetId required
    • code required
    • message required

AssetErrorMessage

  • AssetErrorMessage string

AssetHierarchies

AssetHierarchy

  • AssetHierarchy object: Describes an asset hierarchy that contains a hierarchy's name and ID.
    • id
    • name required

AssetHierarchyInfo

  • AssetHierarchyInfo object: Contains information about a parent asset and a child asset that are related through an asset hierarchy.
    • childAssetId
    • parentAssetId

AssetIDs

  • AssetIDs array

AssetModelCompositeModel

  • AssetModelCompositeModel object: Contains information about a composite model in an asset model. This object contains the asset property definitions that you define in the composite model.

AssetModelCompositeModelDefinition

  • AssetModelCompositeModelDefinition object: Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.

AssetModelCompositeModelDefinitions

AssetModelCompositeModels

AssetModelHierarchies

AssetModelHierarchy

  • AssetModelHierarchy object: Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.
    • childAssetModelId required
    • id
    • name required

AssetModelHierarchyDefinition

  • AssetModelHierarchyDefinition object: Contains an asset model hierarchy used in asset model creation. An asset model hierarchy determines the kind (or type) of asset that can belong to a hierarchy.
    • childAssetModelId required
    • name required

AssetModelHierarchyDefinitions

AssetModelProperties

AssetModelProperty

  • AssetModelProperty object: Contains information about an asset model property.
    • dataType required
    • dataTypeSpec
    • id
    • name required
    • type required
      • attribute
        • defaultValue
      • measurement
      • metric
        • expression required
        • variables required
        • window required
          • tumbling
            • interval required
      • transform
    • unit

AssetModelPropertyDefinition

  • AssetModelPropertyDefinition object: Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
    • dataType required
    • dataTypeSpec
    • name required
    • type required
      • attribute
        • defaultValue
      • measurement
      • metric
        • expression required
        • variables required
        • window required
          • tumbling
            • interval required
      • transform
    • unit

AssetModelPropertyDefinitions

AssetModelState

  • AssetModelState string (values: CREATING, ACTIVE, UPDATING, PROPAGATING, DELETING, FAILED)

AssetModelStatus

  • AssetModelStatus object: Contains current status information for an asset model. For more information, see Asset and model states in the AWS IoT SiteWise User Guide.
    • error
      • code required
      • message required
    • state required

AssetModelSummaries

AssetModelSummary

  • AssetModelSummary object: Contains a summary of an asset model.
    • arn required
    • creationDate required
    • description required
    • id required
    • lastUpdateDate required
    • name required
    • status required
      • error
        • code required
        • message required
      • state required

AssetProperties

AssetProperty

  • AssetProperty object: Contains asset property information.
    • alias
    • dataType required
    • dataTypeSpec
    • id required
    • name required
    • notification
      • state required
      • topic required
    • unit

AssetPropertyAlias

  • AssetPropertyAlias string

AssetPropertyValue

  • AssetPropertyValue object: Contains asset property value information.
    • quality
    • timestamp required
      • offsetInNanos
      • timeInSeconds required
    • value required
      • booleanValue
      • doubleValue
      • integerValue
      • stringValue

AssetPropertyValueHistory

AssetPropertyValues

AssetRelationshipSummaries

AssetRelationshipSummary

  • AssetRelationshipSummary object: Contains information about assets that are related to one another.
    • hierarchyInfo
      • childAssetId
      • parentAssetId
    • relationshipType required

AssetRelationshipType

  • AssetRelationshipType string (values: HIERARCHY)

AssetState

  • AssetState string (values: CREATING, ACTIVE, UPDATING, DELETING, FAILED)

AssetStatus

  • AssetStatus object: Contains information about the current status of an asset. For more information, see Asset and model states in the AWS IoT SiteWise User Guide.
    • error
      • code required
      • message required
    • state required

AssetSummaries

AssetSummary

  • AssetSummary object: Contains a summary of an asset.
    • arn required
    • assetModelId required
    • creationDate required
    • hierarchies required
    • id required
    • lastUpdateDate required
    • name required
    • status required
      • error
        • code required
        • message required
      • state required

AssociateAssetsRequest

  • AssociateAssetsRequest object
    • childAssetId required
    • clientToken
    • hierarchyId required

AssociatedAssetsSummaries

AssociatedAssetsSummary

  • AssociatedAssetsSummary object: Contains a summary of an associated asset.
    • arn required
    • assetModelId required
    • creationDate required
    • hierarchies required
    • id required
    • lastUpdateDate required
    • name required
    • status required
      • error
        • code required
        • message required
      • state required

Attribute

  • Attribute object: Contains an asset attribute property. For more information, see Attributes in the AWS IoT SiteWise User Guide.
    • defaultValue

AuthMode

  • AuthMode string (values: IAM, SSO)

BatchAssociateProjectAssetsErrors

BatchAssociateProjectAssetsRequest

  • BatchAssociateProjectAssetsRequest object
    • assetIds required
    • clientToken

BatchAssociateProjectAssetsResponse

BatchDisassociateProjectAssetsErrors

BatchDisassociateProjectAssetsRequest

  • BatchDisassociateProjectAssetsRequest object
    • assetIds required
    • clientToken

BatchDisassociateProjectAssetsResponse

BatchPutAssetPropertyError

  • BatchPutAssetPropertyError object: Contains error information from updating a batch of asset property values.
    • errorCode required
    • errorMessage required
    • timestamps required

BatchPutAssetPropertyErrorEntries

BatchPutAssetPropertyErrorEntry

  • BatchPutAssetPropertyErrorEntry object: Contains error information for asset property value entries that are associated with the BatchPutAssetPropertyValue API.

BatchPutAssetPropertyErrors

BatchPutAssetPropertyValueErrorCode

  • BatchPutAssetPropertyValueErrorCode string (values: ResourceNotFoundException, InvalidRequestException, InternalFailureException, ServiceUnavailableException, ThrottlingException, LimitExceededException, ConflictingOperationException, TimestampOutOfRangeException, AccessDeniedException)

BatchPutAssetPropertyValueRequest

BatchPutAssetPropertyValueResponse

CapabilityConfiguration

  • CapabilityConfiguration string

CapabilityNamespace

  • CapabilityNamespace string

CapabilitySyncStatus

  • CapabilitySyncStatus string (values: IN_SYNC, OUT_OF_SYNC, SYNC_FAILED)

ClientToken

  • ClientToken string

CompositeModelProperty

  • CompositeModelProperty object: Contains information about a composite model property on an asset.
    • assetProperty required Property
    • name required
    • type required

ConfigurationErrorDetails

  • ConfigurationErrorDetails object: Contains the details of an AWS IoT SiteWise configuration error.
    • code required
    • message required

ConfigurationState

  • ConfigurationState string (values: ACTIVE, UPDATE_IN_PROGRESS, UPDATE_FAILED)

ConfigurationStatus

  • ConfigurationStatus object: Contains current status information for the configuration.
    • error
      • code required
      • message required
    • state required

ConflictingOperationException

CreateAccessPolicyRequest

  • CreateAccessPolicyRequest object
    • tags
    • accessPolicyIdentity required
      • group
        • id required
      • iamUser
        • arn required
      • user
        • id required
    • accessPolicyPermission required
    • accessPolicyResource required
      • portal
        • id required
      • project
        • id required
    • clientToken

CreateAccessPolicyResponse

  • CreateAccessPolicyResponse object
    • accessPolicyArn required
    • accessPolicyId required

CreateAssetModelRequest

CreateAssetModelResponse

  • CreateAssetModelResponse object
    • assetModelArn required
    • assetModelId required
    • assetModelStatus required
      • error
        • code required
        • message required
      • state required

CreateAssetRequest

  • CreateAssetRequest object
    • tags
    • assetModelId required
    • assetName required
    • clientToken

CreateAssetResponse

  • CreateAssetResponse object
    • assetArn required
    • assetId required
    • assetStatus required
      • error
        • code required
        • message required
      • state required

CreateDashboardRequest

  • CreateDashboardRequest object
    • tags
    • clientToken
    • dashboardDefinition required
    • dashboardDescription
    • dashboardName required
    • projectId required

CreateDashboardResponse

  • CreateDashboardResponse object
    • dashboardArn required
    • dashboardId required

CreateGatewayRequest

  • CreateGatewayRequest object
    • tags
    • gatewayName required
    • gatewayPlatform required
      • greengrass required
        • groupArn required

CreateGatewayResponse

  • CreateGatewayResponse object
    • gatewayArn required
    • gatewayId required

CreatePortalRequest

  • CreatePortalRequest object
    • tags
    • clientToken
    • portalAuthMode
    • portalContactEmail required
    • portalDescription
    • portalLogoImageFile
      • data required
      • type required
    • portalName required
    • roleArn required

CreatePortalResponse

  • CreatePortalResponse object
    • portalArn required
    • portalId required
    • portalStartUrl required
    • portalStatus required
      • error
        • code
        • message
      • state required
    • ssoApplicationId required

CreateProjectRequest

  • CreateProjectRequest object
    • tags
    • clientToken
    • portalId required
    • projectDescription
    • projectName required

CreateProjectResponse

  • CreateProjectResponse object
    • projectArn required
    • projectId required

DashboardDefinition

  • DashboardDefinition string

DashboardSummaries

DashboardSummary

  • DashboardSummary object: Contains a dashboard summary.
    • creationDate
    • description
    • id required
    • lastUpdateDate
    • name required

DefaultValue

  • DefaultValue string

DeleteAccessPolicyRequest

  • DeleteAccessPolicyRequest object

DeleteAccessPolicyResponse

  • DeleteAccessPolicyResponse object

DeleteAssetModelRequest

  • DeleteAssetModelRequest object

DeleteAssetModelResponse

  • DeleteAssetModelResponse object
    • assetModelStatus required
      • error
        • code required
        • message required
      • state required

DeleteAssetRequest

  • DeleteAssetRequest object

DeleteAssetResponse

  • DeleteAssetResponse object
    • assetStatus required
      • error
        • code required
        • message required
      • state required

DeleteDashboardRequest

  • DeleteDashboardRequest object

DeleteDashboardResponse

  • DeleteDashboardResponse object

DeleteGatewayRequest

  • DeleteGatewayRequest object

DeletePortalRequest

  • DeletePortalRequest object

DeletePortalResponse

  • DeletePortalResponse object
    • portalStatus required
      • error
        • code
        • message
      • state required

DeleteProjectRequest

  • DeleteProjectRequest object

DeleteProjectResponse

  • DeleteProjectResponse object

DescribeAccessPolicyRequest

  • DescribeAccessPolicyRequest object

DescribeAccessPolicyResponse

  • DescribeAccessPolicyResponse object
    • accessPolicyArn required
    • accessPolicyCreationDate required
    • accessPolicyId required
    • accessPolicyIdentity required
      • group
        • id required
      • iamUser
        • arn required
      • user
        • id required
    • accessPolicyLastUpdateDate required
    • accessPolicyPermission required
    • accessPolicyResource required
      • portal
        • id required
      • project
        • id required

DescribeAssetModelRequest

  • DescribeAssetModelRequest object

DescribeAssetModelResponse

  • DescribeAssetModelResponse object
    • assetModelArn required
    • assetModelCompositeModels
    • assetModelCreationDate required
    • assetModelDescription required
    • assetModelHierarchies required
    • assetModelId required
    • assetModelLastUpdateDate required
    • assetModelName required
    • assetModelProperties required
    • assetModelStatus required
      • error
        • code required
        • message required
      • state required

DescribeAssetPropertyRequest

  • DescribeAssetPropertyRequest object

DescribeAssetPropertyResponse

  • DescribeAssetPropertyResponse object
    • assetId required
    • assetModelId required
    • assetName required
    • assetProperty
      • alias
      • dataType required
      • id required
      • name required
      • notification
        • state required
        • topic required
      • type
        • attribute
          • defaultValue
        • measurement
        • metric
        • transform
      • unit
    • compositeModel
      • assetProperty required Property
      • name required
      • type required

DescribeAssetRequest

  • DescribeAssetRequest object

DescribeAssetResponse

  • DescribeAssetResponse object
    • assetArn required
    • assetCompositeModels
    • assetCreationDate required
    • assetHierarchies required
    • assetId required
    • assetLastUpdateDate required
    • assetModelId required
    • assetName required
    • assetProperties required
    • assetStatus required
      • error
        • code required
        • message required
      • state required

DescribeDashboardRequest

  • DescribeDashboardRequest object

DescribeDashboardResponse

  • DescribeDashboardResponse object
    • dashboardArn required
    • dashboardCreationDate required
    • dashboardDefinition required
    • dashboardDescription
    • dashboardId required
    • dashboardLastUpdateDate required
    • dashboardName required
    • projectId required

DescribeDefaultEncryptionConfigurationRequest

  • DescribeDefaultEncryptionConfigurationRequest object

DescribeDefaultEncryptionConfigurationResponse

  • DescribeDefaultEncryptionConfigurationResponse object
    • configurationStatus required
      • error
        • code required
        • message required
      • state required
    • encryptionType required
    • kmsKeyArn

DescribeGatewayCapabilityConfigurationRequest

  • DescribeGatewayCapabilityConfigurationRequest object

DescribeGatewayCapabilityConfigurationResponse

  • DescribeGatewayCapabilityConfigurationResponse object
    • capabilityConfiguration required
    • capabilityNamespace required
    • capabilitySyncStatus required
    • gatewayId required

DescribeGatewayRequest

  • DescribeGatewayRequest object

DescribeGatewayResponse

  • DescribeGatewayResponse object
    • creationDate required
    • gatewayArn required
    • gatewayCapabilitySummaries required
    • gatewayId required
    • gatewayName required
    • gatewayPlatform
      • greengrass required
        • groupArn required
    • lastUpdateDate required

DescribeLoggingOptionsRequest

  • DescribeLoggingOptionsRequest object

DescribeLoggingOptionsResponse

  • DescribeLoggingOptionsResponse object
    • loggingOptions required
      • level required

DescribePortalRequest

  • DescribePortalRequest object

DescribePortalResponse

  • DescribePortalResponse object
    • portalArn required
    • portalAuthMode
    • portalClientId required
    • portalContactEmail required
    • portalCreationDate required
    • portalDescription
    • portalId required
    • portalLastUpdateDate required
    • portalLogoImageLocation
      • id required
      • url required
    • portalName required
    • portalStartUrl required
    • portalStatus required
      • error
        • code
        • message
      • state required
    • roleArn

DescribeProjectRequest

  • DescribeProjectRequest object

DescribeProjectResponse

  • DescribeProjectResponse object
    • portalId required
    • projectArn required
    • projectCreationDate required
    • projectDescription
    • projectId required
    • projectLastUpdateDate required
    • projectName required

Description

  • Description string

DisassociateAssetsRequest

  • DisassociateAssetsRequest object
    • childAssetId required
    • clientToken
    • hierarchyId required

Email

  • Email string

EncryptionType

  • EncryptionType string (values: SITEWISE_DEFAULT_ENCRYPTION, KMS_BASED_ENCRYPTION)

EntryId

  • EntryId string

ErrorCode

  • ErrorCode string (values: VALIDATION_ERROR, INTERNAL_FAILURE)

ErrorDetails

  • ErrorDetails object: Contains the details of an AWS IoT SiteWise error.
    • code required
    • message required

ErrorMessage

  • ErrorMessage string

Expression

  • Expression string

ExpressionVariable

  • ExpressionVariable object: Contains expression variable information.
    • name required
    • value required
      • hierarchyId
      • propertyId required

ExpressionVariables

GatewayCapabilitySummaries

GatewayCapabilitySummary

  • GatewayCapabilitySummary object: Contains a summary of a gateway capability configuration.
    • capabilityNamespace required
    • capabilitySyncStatus required

GatewayPlatform

  • GatewayPlatform object: Contains a gateway's platform information.
    • greengrass required
      • groupArn required

GatewaySummaries

GatewaySummary

  • GatewaySummary object: Contains a summary of a gateway.
    • creationDate required
    • gatewayCapabilitySummaries
    • gatewayId required
    • gatewayName required
    • lastUpdateDate required

GetAssetPropertyAggregatesRequest

  • GetAssetPropertyAggregatesRequest object

GetAssetPropertyAggregatesResponse

  • GetAssetPropertyAggregatesResponse object

GetAssetPropertyValueHistoryRequest

  • GetAssetPropertyValueHistoryRequest object

GetAssetPropertyValueHistoryResponse

  • GetAssetPropertyValueHistoryResponse object

GetAssetPropertyValueRequest

  • GetAssetPropertyValueRequest object

GetAssetPropertyValueResponse

  • GetAssetPropertyValueResponse object
    • propertyValue
      • quality
      • timestamp required
        • offsetInNanos
        • timeInSeconds required
      • value required
        • booleanValue
        • doubleValue
        • integerValue
        • stringValue

Greengrass

  • Greengrass object: Contains details for a gateway that runs on AWS IoT Greengrass. To create a gateway that runs on AWS IoT Greengrass, you must add the IoT SiteWise connector to a Greengrass group and deploy it. Your Greengrass group must also have permissions to upload data to AWS IoT SiteWise. For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide.
    • groupArn required

GroupIdentity

  • GroupIdentity object: Contains information for a group identity in an access policy.
    • id required

IAMUserIdentity

  • IAMUserIdentity object: Contains information about an AWS Identity and Access Management (IAM) user.
    • arn required

ID

  • ID string

IDs

  • IDs array

Identity

  • Identity object: Contains an identity that can access an AWS IoT SiteWise Monitor resource. Currently, you can't use AWS APIs to retrieve AWS SSO identity IDs. You can find the AWS SSO identity IDs in the URL of user and group pages in the AWS SSO console.
    • group
      • id required
    • iamUser
      • arn required
    • user
      • id required

IdentityId

  • IdentityId string

IdentityType

  • IdentityType string (values: USER, GROUP, IAM)

Image

  • Image object: 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.

ImageFile

  • ImageFile object: Contains an image file.
    • data required
    • type required

ImageFileData

  • ImageFileData string

ImageFileType

  • ImageFileType string (values: PNG)

ImageLocation

  • ImageLocation object: Contains an image that is uploaded to AWS IoT SiteWise and available at a URL.
    • id required
    • url required

InternalFailureException

Interval

  • Interval string

InvalidRequestException

KmsKeyId

  • KmsKeyId string

LimitExceededException

ListAccessPoliciesRequest

  • ListAccessPoliciesRequest object

ListAccessPoliciesResponse

  • ListAccessPoliciesResponse object

ListAssetModelsRequest

  • ListAssetModelsRequest object

ListAssetModelsResponse

  • ListAssetModelsResponse object

ListAssetRelationshipsRe

datafireaws-sdk
@infinitebrahmanuniverse/nolb-_datafire_am@everything-registry/sub-chunk-220
5.0.0

5 years ago