package types

import "github.com/aws/aws-sdk-go-v2/service/iotsitewise/types"

Index

Types

type AccessPolicySummary

type AccessPolicySummary struct {
	// The AWS IoT SiteWise Monitor resource (a portal or project).
	Resource *Resource
	// The date the access policy was last updated, in Unix epoch time.
	LastUpdateDate *time.Time
	// The AWS SSO identity (a user or group).
	Identity *Identity
	// The permissions for the access policy. Note that a project ADMINISTRATOR is also
	// known as a project owner.
	Permission Permission
	// The ID of the access policy.
	Id *string
	// The date the access policy was created, in Unix epoch time.
	CreationDate *time.Time
}

Contains an access policy that defines an AWS SSO identity's access to an AWS IoT SiteWise Monitor resource.

type AggregateType

type AggregateType string
const (
	AggregateTypeAverage            AggregateType = "AVERAGE"
	AggregateTypeCount              AggregateType = "COUNT"
	AggregateTypeMaximum            AggregateType = "MAXIMUM"
	AggregateTypeMinimum            AggregateType = "MINIMUM"
	AggregateTypeSum                AggregateType = "SUM"
	AggregateTypeStandard_deviation AggregateType = "STANDARD_DEVIATION"
)

Enum values for AggregateType

type AggregatedValue

type AggregatedValue struct {
	// The value of the aggregates.
	Value *Aggregates
	// The date the aggregating computations occurred, in Unix epoch time.
	Timestamp *time.Time
	// The quality of the aggregated data.
	Quality Quality
}

Contains aggregated asset property values (for example, average, minimum, and maximum).

type Aggregates

type Aggregates struct {
	// The sum of the time series over a time interval window.
	Sum *float64
	// The average (mean) value of the time series over a time interval window.
	Average *float64
	// The maximum value of the time series over a time interval window.
	Maximum *float64
	// The count of data points in the time series over a time interval window.
	Count *float64
	// The standard deviation of the time series over a time interval window.
	StandardDeviation *float64
	// The minimum value of the time series over a time interval window.
	Minimum *float64
}

Contains the (pre-calculated) aggregate values for an asset property.

type AssetErrorCode

type AssetErrorCode string
const (
	AssetErrorCodeInternal_failure AssetErrorCode = "INTERNAL_FAILURE"
)

Enum values for AssetErrorCode

type AssetErrorDetails

type AssetErrorDetails struct {
	// The error code.
	Code AssetErrorCode
	// The error message.
	Message *string
	// The ID of the asset.
	AssetId *string
}

Contains error details for the requested associate project asset action.

type AssetHierarchy

type AssetHierarchy struct {
	// The hierarchy name provided in the CreateAssetModel
	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html)
	// or UpdateAssetModel
	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)
	// API.
	Name *string
	// The ID of the hierarchy. This ID is a hierarchyId.
	Id *string
}

Describes an asset hierarchy that contains a hierarchy's name and ID.

type AssetModelHierarchy

type AssetModelHierarchy struct {
	// The ID of the asset model. All assets in this hierarchy must be instances of the
	// childAssetModelId asset model.
	ChildAssetModelId *string
	// The ID of the asset model hierarchy. This ID is a hierarchyId.
	Id *string
	// The name of the asset model hierarchy that you specify by using the
	// CreateAssetModel
	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html)
	// or UpdateAssetModel
	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)
	// API.
	Name *string
}

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.

type AssetModelHierarchyDefinition

type AssetModelHierarchyDefinition struct {
	// The ID of an asset model for this hierarchy.
	ChildAssetModelId *string
	// The name of the asset model hierarchy definition (as specified in
	// CreateAssetModel
	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html)
	// or UpdateAssetModel
	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)).
	Name *string
}

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.

type AssetModelProperty

type AssetModelProperty struct {
	// The ID of the asset model property.
	Id *string
	// The unit of the asset model property, such as Newtons or RPM.
	Unit *string
	// The name of the asset model property.
	Name *string
	// The property type (see PropertyType).
	Type *PropertyType
	// The data type of the asset model property.
	DataType PropertyDataType
}

Contains information about an asset model property.

type AssetModelPropertyDefinition

type AssetModelPropertyDefinition struct {
	// The property definition type (see PropertyType). You can only specify one type
	// in a property definition.
	Type *PropertyType
	// The data type of the property definition.
	DataType PropertyDataType
	// The name of the property definition.
	Name *string
	// The unit of the property definition, such as Newtons or RPM.
	Unit *string
}

Contains an asset model property definition. This property definition is applied to all assets created from the asset model.

type AssetModelState

type AssetModelState string
const (
	AssetModelStateCreating    AssetModelState = "CREATING"
	AssetModelStateActive      AssetModelState = "ACTIVE"
	AssetModelStateUpdating    AssetModelState = "UPDATING"
	AssetModelStatePropagating AssetModelState = "PROPAGATING"
	AssetModelStateDeleting    AssetModelState = "DELETING"
	AssetModelStateFailed      AssetModelState = "FAILED"
)

Enum values for AssetModelState

type AssetModelStatus

type AssetModelStatus struct {
	// The current state of the asset model.
	State AssetModelState
	// Contains associated error information, if any.
	Error *ErrorDetails
}

Contains current status information for an asset model. For more information, see Asset and Model States (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html) in the AWS IoT SiteWise User Guide.

type AssetModelSummary

type AssetModelSummary struct {
	// The date the asset model was created, in Unix epoch time.
	CreationDate *time.Time
	// The ARN
	// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of
	// the asset model, which has the following format.
	// arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
	Arn *string
	// The ID of the asset model (used with AWS IoT SiteWise APIs).
	Id *string
	// The name of the asset model.
	Name *string
	// The asset model description.
	Description *string
	// The current status of the asset model.
	Status *AssetModelStatus
	// The date the asset model was last updated, in Unix epoch time.
	LastUpdateDate *time.Time
}

Contains a summary of an asset model.

type AssetProperty

type AssetProperty struct {
	// The asset property's notification topic and state. For more information, see
	// UpdateAssetProperty
	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html)
	Notification *PropertyNotification
	// The data type of the asset property.
	DataType PropertyDataType
	// The unit (such as Newtons or RPM) of the asset property.
	Unit *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
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the AWS IoT SiteWise User Guide.
	Alias *string
	// The ID of the asset property.
	Id *string
	// The name of the property.
	Name *string
}

Contains asset property information.

type AssetPropertyValue

type AssetPropertyValue struct {
	// The value of the asset property (see Variant).
	Value *Variant
	// The timestamp of the asset property value.
	Timestamp *TimeInNanos
	// The quality of the asset property value.
	Quality Quality
}

Contains asset property value information.

type AssetState

type AssetState string
const (
	AssetStateCreating AssetState = "CREATING"
	AssetStateActive   AssetState = "ACTIVE"
	AssetStateUpdating AssetState = "UPDATING"
	AssetStateDeleting AssetState = "DELETING"
	AssetStateFailed   AssetState = "FAILED"
)

Enum values for AssetState

type AssetStatus

type AssetStatus struct {
	// Contains associated error information, if any.
	Error *ErrorDetails
	// The current status of the asset.
	State AssetState
}

Contains information about the current status of an asset. For more information, see Asset and Model States (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html) in the AWS IoT SiteWise User Guide.

type AssetSummary

type AssetSummary struct {
	// A list of asset hierarchies that each contain a hierarchyId. A hierarchy
	// specifies allowed parent/child asset relationships.
	Hierarchies []*AssetHierarchy
	// The ID of the asset.
	Id *string
	// The name of the asset.
	Name *string
	// The ARN
	// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of
	// the asset, which has the following format.
	// arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
	Arn *string
	// The date the asset was created, in Unix epoch time.
	CreationDate *time.Time
	// The current status of the asset.
	Status *AssetStatus
	// The ID of the asset model used to create this asset.
	AssetModelId *string
	// The date the asset was last updated, in Unix epoch time.
	LastUpdateDate *time.Time
}

Contains a summary of an asset.

type AssociatedAssetsSummary

type AssociatedAssetsSummary struct {
	// The date the asset was created, in Unix epoch time.
	CreationDate *time.Time
	// The ID of the asset model used to create the asset.
	AssetModelId *string
	// The name of the asset.
	Name *string
	// The ARN
	// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of
	// the asset, which has the following format.
	// arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
	Arn *string
	// The date the asset was last updated, in Unix epoch time.
	LastUpdateDate *time.Time
	// The current status of the asset.
	Status *AssetStatus
	// A list of asset hierarchies that each contain a hierarchyId. A hierarchy
	// specifies allowed parent/child asset relationships.
	Hierarchies []*AssetHierarchy
	// The ID of the asset.
	Id *string
}

Contains a summary of an associated asset.

type Attribute

type Attribute struct {
	// The default value of the asset model property attribute. All assets that you
	// create from the asset model contain this attribute value. You can update an
	// attribute's value after you create an asset. For more information, see Updating
	// Attribute Values
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-attribute-values.html)
	// in the AWS IoT SiteWise User Guide.
	DefaultValue *string
}

Contains an asset attribute property. For more information, see Attributes (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#attributes) in the AWS IoT SiteWise User Guide.

type BatchPutAssetPropertyError

type BatchPutAssetPropertyError struct {
	// A list of timestamps for each error, if any.
	Timestamps []*TimeInNanos
	// The error code.
	ErrorCode BatchPutAssetPropertyValueErrorCode
	// The associated error message.
	ErrorMessage *string
}

Contains error information from updating a batch of asset property values.

type BatchPutAssetPropertyErrorEntry

type BatchPutAssetPropertyErrorEntry struct {
	// The list of update property value errors.
	Errors []*BatchPutAssetPropertyError
	// The ID of the failed entry.
	EntryId *string
}

Contains error information for asset property value entries that are associated with the BatchPutAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html) API.

type BatchPutAssetPropertyValueErrorCode

type BatchPutAssetPropertyValueErrorCode string
const (
	BatchPutAssetPropertyValueErrorCodeResourcenotfoundexception     BatchPutAssetPropertyValueErrorCode = "ResourceNotFoundException"
	BatchPutAssetPropertyValueErrorCodeInvalidrequestexception       BatchPutAssetPropertyValueErrorCode = "InvalidRequestException"
	BatchPutAssetPropertyValueErrorCodeInternalfailureexception      BatchPutAssetPropertyValueErrorCode = "InternalFailureException"
	BatchPutAssetPropertyValueErrorCodeServiceunavailableexception   BatchPutAssetPropertyValueErrorCode = "ServiceUnavailableException"
	BatchPutAssetPropertyValueErrorCodeThrottlingexception           BatchPutAssetPropertyValueErrorCode = "ThrottlingException"
	BatchPutAssetPropertyValueErrorCodeLimitexceededexception        BatchPutAssetPropertyValueErrorCode = "LimitExceededException"
	BatchPutAssetPropertyValueErrorCodeConflictingoperationexception BatchPutAssetPropertyValueErrorCode = "ConflictingOperationException"
	BatchPutAssetPropertyValueErrorCodeTimestampoutofrangeexception  BatchPutAssetPropertyValueErrorCode = "TimestampOutOfRangeException"
	BatchPutAssetPropertyValueErrorCodeAccessdeniedexception         BatchPutAssetPropertyValueErrorCode = "AccessDeniedException"
)

Enum values for BatchPutAssetPropertyValueErrorCode

type CapabilitySyncStatus

type CapabilitySyncStatus string
const (
	CapabilitySyncStatusIn_sync     CapabilitySyncStatus = "IN_SYNC"
	CapabilitySyncStatusOut_of_sync CapabilitySyncStatus = "OUT_OF_SYNC"
	CapabilitySyncStatusSync_failed CapabilitySyncStatus = "SYNC_FAILED"
)

Enum values for CapabilitySyncStatus

type ConflictingOperationException

type ConflictingOperationException struct {
	Message *string

	ResourceId  *string
	ResourceArn *string
}

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

func (*ConflictingOperationException) Error

func (*ConflictingOperationException) ErrorCode

func (e *ConflictingOperationException) ErrorCode() string

func (*ConflictingOperationException) ErrorFault

func (*ConflictingOperationException) ErrorMessage

func (e *ConflictingOperationException) ErrorMessage() string

func (*ConflictingOperationException) GetMessage

func (e *ConflictingOperationException) GetMessage() string

func (*ConflictingOperationException) GetResourceArn

func (e *ConflictingOperationException) GetResourceArn() string

func (*ConflictingOperationException) GetResourceId

func (e *ConflictingOperationException) GetResourceId() string

func (*ConflictingOperationException) HasMessage

func (e *ConflictingOperationException) HasMessage() bool

func (*ConflictingOperationException) HasResourceArn

func (e *ConflictingOperationException) HasResourceArn() bool

func (*ConflictingOperationException) HasResourceId

func (e *ConflictingOperationException) HasResourceId() bool

type DashboardSummary

type DashboardSummary struct {
	// The ID of the dashboard.
	Id *string
	// The date the dashboard was created, in Unix epoch time.
	CreationDate *time.Time
	// The date the dashboard was last updated, in Unix epoch time.
	LastUpdateDate *time.Time
	// The dashboard's description.
	Description *string
	// The name of the dashboard
	Name *string
}

Contains a dashboard summary.

type ErrorCode

type ErrorCode string
const (
	ErrorCodeValidation_error ErrorCode = "VALIDATION_ERROR"
	ErrorCodeInternal_failure ErrorCode = "INTERNAL_FAILURE"
)

Enum values for ErrorCode

type ErrorDetails

type ErrorDetails struct {
	// The error code.
	Code ErrorCode
	// The error message.
	Message *string
}

Contains the details of an AWS IoT SiteWise error.

type ExpressionVariable

type ExpressionVariable struct {
	// The variable that identifies an asset property from which to use values.
	Value *VariableValue
	// The friendly name of the variable to be used in the expression.
	Name *string
}

Contains expression variable information.

type GatewayCapabilitySummary

type GatewayCapabilitySummary struct {
	// The namespace of the capability configuration. 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.
	CapabilityNamespace *string
	// 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.
	CapabilitySyncStatus CapabilitySyncStatus
}

Contains a summary of a gateway capability configuration.

type GatewayPlatform

type GatewayPlatform struct {
	// A gateway that runs on AWS IoT Greengrass.
	Greengrass *Greengrass
}

Contains a gateway's platform information.

type GatewaySummary

type GatewaySummary struct {
	// The date the gateway was last updated, in Unix epoch time.
	LastUpdateDate *time.Time
	// The name of the asset.
	GatewayName *string
	// The date the gateway was created, in Unix epoch time.
	CreationDate *time.Time
	// 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
	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html).
	GatewayCapabilitySummaries []*GatewayCapabilitySummary
	// The ID of the gateway device.
	GatewayId *string
}

Contains a summary of a gateway.

type Greengrass

type Greengrass struct {
	// The ARN
	// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of
	// the Greengrass group. For more information about how to find a group's ARN, see
	// ListGroups
	// (https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html)
	// and GetGroup
	// (https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html)
	// in the AWS IoT Greengrass API Reference.
	GroupArn *string
}

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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html) in the AWS IoT SiteWise User Guide.

type GroupIdentity

type GroupIdentity struct {
	// The AWS SSO ID of the group.
	Id *string
}

Contains information for a group identity in an access policy.

type Identity

type Identity struct {
	// A group identity.
	Group *GroupIdentity
	// A user identity.
	User *UserIdentity
}

Contains an AWS SSO identity ID for a user or group. 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 (https://console.aws.amazon.com/singlesignon).

type IdentityType

type IdentityType string
const (
	IdentityTypeUser  IdentityType = "USER"
	IdentityTypeGroup IdentityType = "GROUP"
)

Enum values for IdentityType

type Image

type Image struct {
	// The ID of an existing image. Specify this parameter to keep an existing image.
	Id *string
	// Contains an image file.
	File *ImageFile
}

Contains an image that is one of the following:

this option to upload a new image.

this option to keep an existing image.

type ImageFile

type ImageFile struct {
	// The image file contents, represented as a base64-encoded string. The file size
	// must be less than 1 MB.
	Data []byte
	// The file type of the image.
	Type ImageFileType
}

Contains an image file.

type ImageFileType

type ImageFileType string
const (
	ImageFileTypePng ImageFileType = "PNG"
)

Enum values for ImageFileType

type ImageLocation

type ImageLocation struct {
	// The URL where the image is available. The URL is valid for 15 minutes so that
	// you can view and download the image
	Url *string
	// The ID of the image.
	Id *string
}

Contains an image that is uploaded to AWS IoT SiteWise and available at a URL.

type InternalFailureException

type InternalFailureException struct {
	Message *string
}

AWS IoT SiteWise can't process your request right now. Try again later.

func (*InternalFailureException) Error

func (e *InternalFailureException) Error() string

func (*InternalFailureException) ErrorCode

func (e *InternalFailureException) ErrorCode() string

func (*InternalFailureException) ErrorFault

func (e *InternalFailureException) ErrorFault() smithy.ErrorFault

func (*InternalFailureException) ErrorMessage

func (e *InternalFailureException) ErrorMessage() string

func (*InternalFailureException) GetMessage

func (e *InternalFailureException) GetMessage() string

func (*InternalFailureException) HasMessage

func (e *InternalFailureException) HasMessage() bool

type InvalidRequestException

type InvalidRequestException struct {
	Message *string
}

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

func (*InvalidRequestException) Error

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault

func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault

func (*InvalidRequestException) ErrorMessage

func (e *InvalidRequestException) ErrorMessage() string

func (*InvalidRequestException) GetMessage

func (e *InvalidRequestException) GetMessage() string

func (*InvalidRequestException) HasMessage

func (e *InvalidRequestException) HasMessage() bool

type LimitExceededException

type LimitExceededException struct {
	Message *string
}

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model. For more information, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the AWS IoT SiteWise User Guide.

func (*LimitExceededException) Error

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage

func (e *LimitExceededException) ErrorMessage() string

func (*LimitExceededException) GetMessage

func (e *LimitExceededException) GetMessage() string

func (*LimitExceededException) HasMessage

func (e *LimitExceededException) HasMessage() bool

type ListAssetsFilter

type ListAssetsFilter string
const (
	ListAssetsFilterAll       ListAssetsFilter = "ALL"
	ListAssetsFilterTop_level ListAssetsFilter = "TOP_LEVEL"
)

Enum values for ListAssetsFilter

type LoggingLevel

type LoggingLevel string
const (
	LoggingLevelError LoggingLevel = "ERROR"
	LoggingLevelInfo  LoggingLevel = "INFO"
	LoggingLevelOff   LoggingLevel = "OFF"
)

Enum values for LoggingLevel

type LoggingOptions

type LoggingOptions struct {
	// The AWS IoT SiteWise logging verbosity level.
	Level LoggingLevel
}

Contains logging options.

type Measurement

type Measurement struct {
}

Contains an asset measurement property. This structure is empty. For more information, see Measurements (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#measurements) in the AWS IoT SiteWise User Guide.

type Metric

type Metric struct {
	// The window (time interval) over which AWS IoT SiteWise computes the metric's
	// aggregation expression. AWS IoT SiteWise computes one data point per window.
	Window *MetricWindow
	// The list of variables used in the expression.
	Variables []*ExpressionVariable
	// The mathematical expression that defines the metric aggregation function. You
	// can specify up to 10 variables per expression. You can specify up to 10
	// functions per expression. For more information, see Quotas
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the
	// AWS IoT SiteWise User Guide.
	Expression *string
}

Contains an asset metric property. With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum). The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a root metric can have up to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE. For more information, see Metrics (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics) in the AWS IoT SiteWise User Guide.

type MetricWindow

type MetricWindow struct {
	// The tumbling time interval window.
	Tumbling *TumblingWindow
}

Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).

type MonitorErrorCode

type MonitorErrorCode string
const (
	MonitorErrorCodeInternal_failure MonitorErrorCode = "INTERNAL_FAILURE"
)

Enum values for MonitorErrorCode

type MonitorErrorDetails

type MonitorErrorDetails struct {
	// The error message.
	Message *string
	// The error code.
	Code MonitorErrorCode
}

Contains AWS IoT SiteWise Monitor error details.

type Permission

type Permission string
const (
	PermissionAdministrator Permission = "ADMINISTRATOR"
	PermissionViewer        Permission = "VIEWER"
)

Enum values for Permission

type PortalResource

type PortalResource struct {
	// The ID of the portal.
	Id *string
}

Identifies an AWS IoT SiteWise Monitor portal.

type PortalState

type PortalState string
const (
	PortalStateCreating PortalState = "CREATING"
	PortalStateUpdating PortalState = "UPDATING"
	PortalStateDeleting PortalState = "DELETING"
	PortalStateActive   PortalState = "ACTIVE"
	PortalStateFailed   PortalState = "FAILED"
)

Enum values for PortalState

type PortalStatus

type PortalStatus struct {
	// Contains associated error information, if any.
	Error *MonitorErrorDetails
	// The current state of the portal.
	State PortalState
}

Contains information about the current status of a portal.

type PortalSummary

type PortalSummary struct {
	// The portal's description.
	Description *string
	// The date the portal was last updated, in Unix epoch time.
	LastUpdateDate *time.Time
	// The ARN
	// (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of
	// the 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
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html)
	// in the AWS IoT SiteWise User Guide.
	RoleArn *string
	// The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal.
	StartUrl *string
	// The name of the portal.
	Name *string
	// The ID of the portal.
	Id *string
	// The date the portal was created, in Unix epoch time.
	CreationDate *time.Time
}

Contains a portal summary.

type ProjectResource

type ProjectResource struct {
	// The ID of the project.
	Id *string
}

Identifies a specific AWS IoT SiteWise Monitor project.

type ProjectSummary

type ProjectSummary struct {
	// The project's description.
	Description *string
	// The date the project was last updated, in Unix epoch time.
	LastUpdateDate *time.Time
	// The ID of the project.
	Id *string
	// The date the project was created, in Unix epoch time.
	CreationDate *time.Time
	// The name of the project.
	Name *string
}

Contains project summary information.

type Property

type Property struct {
	// 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
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the AWS IoT SiteWise User Guide.
	Alias *string
	// The property data type.
	DataType PropertyDataType
	// The asset property's notification topic and state. For more information, see
	// UpdateAssetProperty
	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html)
	Notification *PropertyNotification
	// The unit (such as Newtons or RPM) of the asset property.
	Unit *string
	// The ID of the asset property.
	Id *string
	// The property type (see PropertyType). A property contains one type.
	Type *PropertyType
	// The name of the property.
	Name *string
}

Contains asset property information.

type PropertyDataType

type PropertyDataType string
const (
	PropertyDataTypeString  PropertyDataType = "STRING"
	PropertyDataTypeInteger PropertyDataType = "INTEGER"
	PropertyDataTypeDouble  PropertyDataType = "DOUBLE"
	PropertyDataTypeBoolean PropertyDataType = "BOOLEAN"
)

Enum values for PropertyDataType

type PropertyNotification

type PropertyNotification struct {
	// The current notification state.
	State PropertyNotificationState
	// The MQTT topic to which AWS IoT SiteWise publishes property value update
	// notifications.
	Topic *string
}

Contains asset property value notification information. 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) in the AWS IoT SiteWise User Guide.

type PropertyNotificationState

type PropertyNotificationState string
const (
	PropertyNotificationStateEnabled  PropertyNotificationState = "ENABLED"
	PropertyNotificationStateDisabled PropertyNotificationState = "DISABLED"
)

Enum values for PropertyNotificationState

type PropertyType

type PropertyType struct {
	// Specifies an asset measurement property. A measurement represents a device's raw
	// sensor data stream, such as timestamped temperature values or timestamped power
	// values.
	Measurement *Measurement
	// Specifies an asset metric property. A metric contains a mathematical expression
	// that uses aggregate functions to process all input data points over a time
	// interval and output a single data point, such as to calculate the average hourly
	// temperature.
	Metric *Metric
	// Specifies an asset attribute property. An attribute generally contains static
	// information, such as the serial number of an IIoT
	// (https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications) wind
	// turbine.
	Attribute *Attribute
	// Specifies an asset transform property. A transform contains a mathematical
	// expression that maps a property's data points from one form to another, such as
	// a unit conversion from Celsius to Fahrenheit.
	Transform *Transform
}

Contains a property type, which can be one of attribute, measurement, metric, or transform.

type PutAssetPropertyValueEntry

type PutAssetPropertyValueEntry struct {
	// The ID of the asset property for this entry.
	PropertyId *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
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the AWS IoT SiteWise User Guide.
	PropertyAlias *string
	// The list of property values to upload. You can specify up to 10 propertyValues
	// array elements.
	PropertyValues []*AssetPropertyValue
	// The user specified ID for the entry. You can use this ID to identify which
	// entries failed.
	EntryId *string
	// The ID of the asset to update.
	AssetId *string
}

Contains a list of value updates for an asset property in the list of asset entries consumed by the BatchPutAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html) API.

type Quality

type Quality string
const (
	QualityGood      Quality = "GOOD"
	QualityBad       Quality = "BAD"
	QualityUncertain Quality = "UNCERTAIN"
)

Enum values for Quality

type Resource

type Resource struct {
	// A portal resource.
	Portal *PortalResource
	// A project resource.
	Project *ProjectResource
}

Contains an AWS IoT SiteWise Monitor resource ID for a portal or project.

type ResourceAlreadyExistsException

type ResourceAlreadyExistsException struct {
	Message *string

	ResourceId  *string
	ResourceArn *string
}

The resource already exists.

func (*ResourceAlreadyExistsException) Error

func (*ResourceAlreadyExistsException) ErrorCode

func (e *ResourceAlreadyExistsException) ErrorCode() string

func (*ResourceAlreadyExistsException) ErrorFault

func (*ResourceAlreadyExistsException) ErrorMessage

func (e *ResourceAlreadyExistsException) ErrorMessage() string

func (*ResourceAlreadyExistsException) GetMessage

func (e *ResourceAlreadyExistsException) GetMessage() string

func (*ResourceAlreadyExistsException) GetResourceArn

func (e *ResourceAlreadyExistsException) GetResourceArn() string

func (*ResourceAlreadyExistsException) GetResourceId

func (e *ResourceAlreadyExistsException) GetResourceId() string

func (*ResourceAlreadyExistsException) HasMessage

func (e *ResourceAlreadyExistsException) HasMessage() bool

func (*ResourceAlreadyExistsException) HasResourceArn

func (e *ResourceAlreadyExistsException) HasResourceArn() bool

func (*ResourceAlreadyExistsException) HasResourceId

func (e *ResourceAlreadyExistsException) HasResourceId() bool

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string
}

The requested resource can't be found.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

func (*ResourceNotFoundException) GetMessage

func (e *ResourceNotFoundException) GetMessage() string

func (*ResourceNotFoundException) HasMessage

func (e *ResourceNotFoundException) HasMessage() bool

type ResourceType

type ResourceType string
const (
	ResourceTypePortal  ResourceType = "PORTAL"
	ResourceTypeProject ResourceType = "PROJECT"
)

Enum values for ResourceType

type ServiceUnavailableException

type ServiceUnavailableException struct {
	Message *string
}

The requested service is unavailable.

func (*ServiceUnavailableException) Error

func (*ServiceUnavailableException) ErrorCode

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault

func (*ServiceUnavailableException) ErrorMessage

func (e *ServiceUnavailableException) ErrorMessage() string

func (*ServiceUnavailableException) GetMessage

func (e *ServiceUnavailableException) GetMessage() string

func (*ServiceUnavailableException) HasMessage

func (e *ServiceUnavailableException) HasMessage() bool

type ThrottlingException

type ThrottlingException struct {
	Message *string
}

Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on. For more information, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the AWS IoT SiteWise User Guide.

func (*ThrottlingException) Error

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage

func (e *ThrottlingException) ErrorMessage() string

func (*ThrottlingException) GetMessage

func (e *ThrottlingException) GetMessage() string

func (*ThrottlingException) HasMessage

func (e *ThrottlingException) HasMessage() bool

type TimeInNanos

type TimeInNanos struct {
	// The nanosecond offset from timeInSeconds.
	OffsetInNanos *int32
	// The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond
	// data is provided by offsetInNanos.
	TimeInSeconds *int64
}

Contains a timestamp with optional nanosecond granularity.

type TimeOrdering

type TimeOrdering string
const (
	TimeOrderingAscending  TimeOrdering = "ASCENDING"
	TimeOrderingDescending TimeOrdering = "DESCENDING"
)

Enum values for TimeOrdering

type TooManyTagsException

type TooManyTagsException struct {
	Message *string

	ResourceName *string
}

You've reached the limit for the number of tags allowed for a resource. For more information, see Tag naming limits and requirements (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions) in the AWS General Reference.

func (*TooManyTagsException) Error

func (e *TooManyTagsException) Error() string

func (*TooManyTagsException) ErrorCode

func (e *TooManyTagsException) ErrorCode() string

func (*TooManyTagsException) ErrorFault

func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault

func (*TooManyTagsException) ErrorMessage

func (e *TooManyTagsException) ErrorMessage() string

func (*TooManyTagsException) GetMessage

func (e *TooManyTagsException) GetMessage() string

func (*TooManyTagsException) GetResourceName

func (e *TooManyTagsException) GetResourceName() string

func (*TooManyTagsException) HasMessage

func (e *TooManyTagsException) HasMessage() bool

func (*TooManyTagsException) HasResourceName

func (e *TooManyTagsException) HasResourceName() bool

type Transform

type Transform struct {
	// The mathematical expression that defines the transformation function. You can
	// specify up to 10 variables per expression. You can specify up to 10 functions
	// per expression. For more information, see Quotas
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the
	// AWS IoT SiteWise User Guide.
	Expression *string
	// The list of variables used in the expression.
	Variables []*ExpressionVariable
}

Contains an asset transform property. A transform is a one-to-one mapping of a property's data points from one form to another. For example, you can use a transform to convert a Celsius data stream to Fahrenheit by applying the transformation expression to each data point of the Celsius stream. A transform can only have a data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE. For more information, see Transforms (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#transforms) in the AWS IoT SiteWise User Guide.

type TumblingWindow

type TumblingWindow struct {
	// The time interval for the tumbling window. Note that w represents weeks, d
	// represents days, h represents hours, and m represents minutes. AWS IoT SiteWise
	// computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d
	// interval at the end of each day at midnight (UTC), the 1h interval at the end of
	// each hour, and so on. When AWS IoT SiteWise aggregates data points for metric
	// computations, the start of each interval is exclusive and the end of each
	// interval is inclusive. AWS IoT SiteWise places the computed data point at the
	// end of the interval.
	Interval *string
}

Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time interval. This window is used in metric and aggregation computations.

type UserIdentity

type UserIdentity struct {
	// The AWS SSO ID of the user.
	Id *string
}

Contains information for a user identity in an access policy.

type VariableValue

type VariableValue struct {
	// The ID of the property to use as the variable. You can use the property name if
	// it's from the same asset model.
	PropertyId *string
	// The ID of the hierarchy to query for the property ID. You can use the
	// hierarchy's name instead of the hierarchy's ID. You use a hierarchy ID instead
	// of a model ID because you can have several hierarchies using the same model and
	// therefore the same propertyId. For example, you might have separately grouped
	// assets that come from the same asset model. For more information, see Asset
	// Hierarchies
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html)
	// in the AWS IoT SiteWise User Guide.
	HierarchyId *string
}

Identifies a property value used in an expression.

type Variant

type Variant struct {
	// Asset property data of type string (sequence of characters).
	StringValue *string
	// Asset property data of type Boolean (true or false).
	BooleanValue *bool
	// Asset property data of type integer (whole number).
	IntegerValue *int32
	// Asset property data of type double (floating point number).
	DoubleValue *float64
}

Contains an asset property value (of a single type only).

Source Files

enums.go errors.go types.go

Version
v0.1.0
Published
Sep 29, 2020
Platform
js/wasm
Imports
4 packages
Last checked
6 days ago

Tools for package owners.