types

package
v0.0.0-...-68f2935 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 24, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Access is denied.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

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

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AccessPolicySummary 

type AccessPolicySummary struct {

	// The ID of the access policy.
	//
	// This member is required.
	Id *string

	// The identity (an IAM Identity Center user, an IAM Identity Center group, or an
	// IAM user).
	//
	// This member is required.
	Identity *Identity

	// The permissions for the access policy. Note that a project ADMINISTRATOR is
	// also known as a project owner.
	//
	// This member is required.
	Permission Permission

	// The IoT SiteWise Monitor resource (a portal or project).
	//
	// This member is required.
	Resource *Resource

	// The date the access policy was created, in Unix epoch time.
	CreationDate *time.Time

	// The date the access policy was last updated, in Unix epoch time.
	LastUpdateDate *time.Time
	// contains filtered or unexported fields
}

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

type ActionDefinition 

type ActionDefinition struct {

	// The ID of the action definition.
	//
	// This member is required.
	ActionDefinitionId *string

	// The name of the action definition.
	//
	// This member is required.
	ActionName *string

	// The type of the action definition.
	//
	// This member is required.
	ActionType *string
	// contains filtered or unexported fields
}

Contains a definition for an action.

type ActionPayload 

type ActionPayload struct {

	// The payload of the action in a JSON string.
	//
	// This member is required.
	StringValue *string
	// contains filtered or unexported fields
}

The JSON payload of the action.

type ActionSummary 

type ActionSummary struct {

	// The ID of the action definition.
	ActionDefinitionId *string

	// The ID of the action.
	ActionId *string

	// The resource the action will be taken on.
	TargetResource *TargetResource
	// contains filtered or unexported fields
}

Contains the summary of the actions.

type AggregateType 

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

Enum values for AggregateType

func (AggregateType) Values 

func (AggregateType) Values() []AggregateType

Values returns all known values for AggregateType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AggregatedValue 

type AggregatedValue struct {

	// The date the aggregating computations occurred, in Unix epoch time.
	//
	// This member is required.
	Timestamp *time.Time

	// The value of the aggregates.
	//
	// This member is required.
	Value *Aggregates

	// The quality of the aggregated data.
	Quality Quality
	// contains filtered or unexported fields
}

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

type Aggregates 

type Aggregates struct {

	// The average (mean) value of the time series over a time interval window.
	Average *float64

	// The count of data points in the time series over a time interval window.
	Count *float64

	// The maximum value of the time series over a time interval window.
	Maximum *float64

	// The minimum value of the time series over a time interval window.
	Minimum *float64

	// The standard deviation of the time series over a time interval window.
	StandardDeviation *float64

	// The sum of the time series over a time interval window.
	Sum *float64
	// contains filtered or unexported fields
}

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

type Alarms 

type Alarms struct {

	// The [ARN] of the IAM role that allows the alarm to perform actions and access Amazon
	// Web Services resources and services, such as IoT Events.
	//
	// [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	AlarmRoleArn *string

	// The [ARN] of the Lambda function that manages alarm notifications. For more
	// information, see [Managing alarm notifications]in the IoT Events Developer Guide.
	//
	// [Managing alarm notifications]: https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html
	// [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	NotificationLambdaArn *string
	// contains filtered or unexported fields
}

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

type AssetCompositeModel 

type AssetCompositeModel struct {

	// The name of the composite model.
	//
	// This member is required.
	Name *string

	// The asset properties that this composite model defines.
	//
	// This member is required.
	Properties []AssetProperty

	// The type of the composite model. For alarm composite models, this type is
	// AWS/ALARM .
	//
	// This member is required.
	Type *string

	// The description of the composite model.
	Description *string

	// The external ID of the asset composite model. For more information, see [Using external IDs] in the
	// IoT SiteWise User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	ExternalId *string

	//  The ID of the asset composite model.
	Id *string
	// contains filtered or unexported fields
}

Contains information about a composite model in an asset. This object contains the asset's properties that you define in the composite model.

type AssetCompositeModelPathSegment 

type AssetCompositeModelPathSegment struct {

	// The ID of the path segment.
	Id *string

	// The name of the path segment.
	Name *string
	// contains filtered or unexported fields
}

Represents one level between a composite model and the root of the asset.

type AssetCompositeModelSummary 

type AssetCompositeModelSummary struct {

	// A description of the composite model that this summary describes.
	//
	// This member is required.
	Description *string

	// The ID of the composite model that this summary describes.
	//
	// This member is required.
	Id *string

	// The name of the composite model that this summary describes.
	//
	// This member is required.
	Name *string

	// The path that includes all the components of the asset model for the asset.
	//
	// This member is required.
	Path []AssetCompositeModelPathSegment

	// The type of asset model.
	//
	//   - ASSET_MODEL – (default) An asset model that you can use to create assets.
	//   Can't be included as a component in another asset model.
	//
	//   - COMPONENT_MODEL – A reusable component that you can include in the
	//   composite models of other asset models. You can't create assets directly from
	//   this type of asset model.
	//
	// This member is required.
	Type *string

	// An external ID to assign to the asset model.
	//
	// If the composite model is a derived composite model, or one nested inside a
	// component model, you can only set the external ID using
	// UpdateAssetModelCompositeModel and specifying the derived ID of the model or
	// property from the created model it's a part of.
	ExternalId *string
	// contains filtered or unexported fields
}

Contains a summary of the composite model for a specific asset.

type AssetErrorCode 

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

Enum values for AssetErrorCode

func (AssetErrorCode) Values 

func (AssetErrorCode) Values() []AssetErrorCode

Values returns all known values for AssetErrorCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AssetErrorDetails 

type AssetErrorDetails struct {

	// The ID of the asset, in UUID format.
	//
	// This member is required.
	AssetId *string

	// The error code.
	//
	// This member is required.
	Code AssetErrorCode

	// The error message.
	//
	// This member is required.
	Message *string
	// contains filtered or unexported fields
}

Contains error details for the requested associate project asset action.

type AssetHierarchy 

type AssetHierarchy struct {

	// The hierarchy name provided in the [CreateAssetModel] or [UpdateAssetModel] API operation.
	//
	// [CreateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html
	// [UpdateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
	//
	// This member is required.
	Name *string

	// The external ID of the hierarchy, if it has one. When you update an asset
	// hierarchy, you may assign an external ID if it doesn't already have one. You
	// can't change the external ID of an asset hierarchy that already has one. For
	// more information, see [Using external IDs]in the IoT SiteWise User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	ExternalId *string

	// The ID of the hierarchy. This ID is a hierarchyId .
	Id *string
	// contains filtered or unexported fields
}

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

type AssetHierarchyInfo 

type AssetHierarchyInfo struct {

	// The ID of the child asset in this asset relationship.
	ChildAssetId *string

	// The ID of the parent asset in this asset relationship.
	ParentAssetId *string
	// contains filtered or unexported fields
}

Contains information about a parent asset and a child asset that are related through an asset hierarchy.

type AssetModelCompositeModel 

type AssetModelCompositeModel struct {

	// The name of the composite model.
	//
	// This member is required.
	Name *string

	// The type of the composite model. For alarm composite models, this type is
	// AWS/ALARM .
	//
	// This member is required.
	Type *string

	// The description of the composite model.
	Description *string

	// The external ID of the asset model composite model. For more information, see [Using external IDs]
	// in the IoT SiteWise User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	ExternalId *string

	//  The ID of the asset model composite model.
	Id *string

	// The asset property definitions for this composite model.
	Properties []AssetModelProperty
	// contains filtered or unexported fields
}

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

type AssetModelCompositeModelDefinition 

type AssetModelCompositeModelDefinition struct {

	// The name of the composite model.
	//
	// This member is required.
	Name *string

	// The type of the composite model. For alarm composite models, this type is
	// AWS/ALARM .
	//
	// This member is required.
	Type *string

	// The description of the composite model.
	Description *string

	// An external ID to assign to the composite model. The external ID must be unique
	// among composite models within this asset model. For more information, see [Using external IDs]in
	// the IoT SiteWise User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	ExternalId *string

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

	// The asset property definitions for this composite model.
	Properties []AssetModelPropertyDefinition
	// contains filtered or unexported fields
}

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

type AssetModelCompositeModelPathSegment 

type AssetModelCompositeModelPathSegment struct {

	// The ID of the path segment.
	Id *string

	// The name of the path segment.
	Name *string
	// contains filtered or unexported fields
}

Represents one level between a composite model and the root of the asset model.

type AssetModelCompositeModelSummary 

type AssetModelCompositeModelSummary struct {

	// The ID of the the composite model that this summary describes..
	//
	// This member is required.
	Id *string

	// The name of the the composite model that this summary describes..
	//
	// This member is required.
	Name *string

	// The type of asset model.
	//
	//   - ASSET_MODEL – (default) An asset model that you can use to create assets.
	//   Can't be included as a component in another asset model.
	//
	//   - COMPONENT_MODEL – A reusable component that you can include in the
	//   composite models of other asset models. You can't create assets directly from
	//   this type of asset model.
	//
	// This member is required.
	Type *string

	// The description of the the composite model that this summary describes..
	Description *string

	// The external ID of a composite model on this asset model. For more information,
	// see [Using external IDs]in the IoT SiteWise User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	ExternalId *string

	// The path that includes all the pieces that make up the composite model.
	Path []AssetModelCompositeModelPathSegment
	// contains filtered or unexported fields
}

Contains a summary of the composite model.

type AssetModelHierarchy 

type AssetModelHierarchy struct {

	// The ID of the asset model, in UUID format. All assets in this hierarchy must be
	// instances of the childAssetModelId asset model. IoT SiteWise will always return
	// the actual asset model ID for this value. However, when you are specifying this
	// value as part of a call to [UpdateAssetModel], you may provide either the asset model ID or else
	// externalId: followed by the asset model's external ID. For more information, see [Using external IDs]
	// in the IoT SiteWise User Guide.
	//
	// [UpdateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	//
	// This member is required.
	ChildAssetModelId *string

	// The name of the asset model hierarchy that you specify by using the [CreateAssetModel] or [UpdateAssetModel] API
	// operation.
	//
	// [CreateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html
	// [UpdateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
	//
	// This member is required.
	Name *string

	// The external ID (if any) provided in the [CreateAssetModel] or [UpdateAssetModel] operation. You can assign an
	// external ID by specifying this value as part of a call to [UpdateAssetModel]. However, you can't
	// change the external ID if one is already assigned. For more information, see [Using external IDs]in
	// the IoT SiteWise User Guide.
	//
	// [CreateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html
	// [UpdateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	ExternalId *string

	// The ID of the asset model hierarchy. This ID is a hierarchyId .
	//
	//   - If you are callling [UpdateAssetModel]to create a new hierarchy: You can specify its ID here,
	//   if desired. IoT SiteWise automatically generates a unique ID for you, so this
	//   parameter is never required. However, if you prefer to supply your own ID
	//   instead, you can specify it here in UUID format. If you specify your own ID, it
	//   must be globally unique.
	//
	//   - If you are calling UpdateAssetModel to modify an existing hierarchy: This
	//   can be either the actual ID in UUID format, or else externalId: followed by
	//   the external ID, if it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise
	//   User Guide.
	//
	// [UpdateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	Id *string
	// contains filtered or unexported fields
}

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. This can be either the actual ID
	// in UUID format, or else externalId: followed by the external ID, if it has one.
	// For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.
	//
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	//
	// This member is required.
	ChildAssetModelId *string

	// The name of the asset model hierarchy definition (as specified in the [CreateAssetModel] or [UpdateAssetModel] API
	// operation).
	//
	// [CreateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html
	// [UpdateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
	//
	// This member is required.
	Name *string

	// An external ID to assign to the asset model hierarchy. The external ID must be
	// unique among asset model hierarchies within this asset model. For more
	// information, see [Using external IDs]in the IoT SiteWise User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	ExternalId *string

	// The ID to assign to the asset model hierarchy, if desired. IoT SiteWise
	// automatically generates a unique ID for you, so this parameter is never
	// required. However, if you prefer to supply your own ID instead, you can specify
	// it here in UUID format. If you specify your own ID, it must be globally unique.
	Id *string
	// contains filtered or unexported fields
}

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 data type of the asset model property.
	//
	// This member is required.
	DataType PropertyDataType

	// The name of the asset model property.
	//
	// This member is required.
	Name *string

	// The property type (see PropertyType ).
	//
	// This member is required.
	Type *PropertyType

	// The data type of the structure for this property. This parameter exists on
	// properties that have the STRUCT data type.
	DataTypeSpec *string

	// The external ID (if any) provided in the [CreateAssetModel] or [UpdateAssetModel] operation. You can assign an
	// external ID by specifying this value as part of a call to [UpdateAssetModel]. However, you can't
	// change the external ID if one is already assigned. For more information, see [Using external IDs]in
	// the IoT SiteWise User Guide.
	//
	// [CreateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html
	// [UpdateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	ExternalId *string

	// The ID of the asset model property.
	//
	//   - If you are callling [UpdateAssetModel]to create a new property: You can specify its ID here,
	//   if desired. IoT SiteWise automatically generates a unique ID for you, so this
	//   parameter is never required. However, if you prefer to supply your own ID
	//   instead, you can specify it here in UUID format. If you specify your own ID, it
	//   must be globally unique.
	//
	//   - If you are calling UpdateAssetModel to modify an existing property: This
	//   can be either the actual ID in UUID format, or else externalId: followed by
	//   the external ID, if it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise
	//   User Guide.
	//
	// [UpdateAssetModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	Id *string

	// The structured path to the property from the root of the asset model.
	Path []AssetModelPropertyPathSegment

	// The unit of the asset model property, such as Newtons or RPM .
	Unit *string
	// contains filtered or unexported fields
}

Contains information about an asset model property.

type AssetModelPropertyDefinition 

type AssetModelPropertyDefinition struct {

	// The data type of the property definition.
	//
	// If you specify STRUCT , you must also specify dataTypeSpec to identify the type
	// of the structure for this property.
	//
	// This member is required.
	DataType PropertyDataType

	// The name of the property definition.
	//
	// This member is required.
	Name *string

	// The property definition type (see PropertyType ). You can only specify one type
	// in a property definition.
	//
	// This member is required.
	Type *PropertyType

	// The data type of the structure for this property. This parameter is required on
	// properties that have the STRUCT data type.
	//
	// The options for this parameter depend on the type of the composite model in
	// which you define this property. Use AWS/ALARM_STATE for alarm state in alarm
	// composite models.
	DataTypeSpec *string

	// An external ID to assign to the property definition. The external ID must be
	// unique among property definitions within this asset model. For more information,
	// see [Using external IDs]in the IoT SiteWise User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	ExternalId *string

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

	// The unit of the property definition, such as Newtons or RPM .
	Unit *string
	// contains filtered or unexported fields
}

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

type AssetModelPropertyPathSegment 

type AssetModelPropertyPathSegment struct {

	// The ID of the path segment.
	Id *string

	// The name of the path segment.
	Name *string
	// contains filtered or unexported fields
}

Represents one level between a property and the root of the asset model.

type AssetModelPropertySummary 

type AssetModelPropertySummary struct {

	// The data type of the property.
	//
	// This member is required.
	DataType PropertyDataType

	// The name of the property.
	//
	// This member is required.
	Name *string

	// Contains a property type, which can be one of attribute , measurement , metric ,
	// or transform .
	//
	// This member is required.
	Type *PropertyType

	//  The ID of the composite model that contains the asset model property.
	AssetModelCompositeModelId *string

	// The data type of the structure for this property. This parameter exists on
	// properties that have the STRUCT data type.
	DataTypeSpec *string

	// The external ID of the property. For more information, see [Using external IDs] in the IoT SiteWise
	// User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	ExternalId *string

	// The ID of the property.
	Id *string

	// The structured path to the property from the root of the asset model.
	Path []AssetModelPropertyPathSegment

	// The unit (such as Newtons or RPM ) of the property.
	Unit *string
	// contains filtered or unexported fields
}

Contains a summary of a property associated with a 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

func (AssetModelState) Values 

func (AssetModelState) Values() []AssetModelState

Values returns all known values for AssetModelState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AssetModelStatus 

type AssetModelStatus struct {

	// The current state of the asset model.
	//
	// This member is required.
	State AssetModelState

	// Contains associated error information, if any.
	Error *ErrorDetails
	// contains filtered or unexported fields
}

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

type AssetModelSummary 

type AssetModelSummary struct {

	// The [ARN] of the asset model, which has the following format.
	//
	//     arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
	//
	// [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	Arn *string

	// The date the asset model was created, in Unix epoch time.
	//
	// This member is required.
	CreationDate *time.Time

	// The asset model description.
	//
	// This member is required.
	Description *string

	// The ID of the asset model (used with IoT SiteWise API operations).
	//
	// This member is required.
	Id *string

	// The date the asset model was last updated, in Unix epoch time.
	//
	// This member is required.
	LastUpdateDate *time.Time

	// The name of the asset model.
	//
	// This member is required.
	Name *string

	// The current status of the asset model.
	//
	// This member is required.
	Status *AssetModelStatus

	// The type of asset model.
	//
	//   - ASSET_MODEL – (default) An asset model that you can use to create assets.
	//   Can't be included as a component in another asset model.
	//
	//   - COMPONENT_MODEL – A reusable component that you can include in the
	//   composite models of other asset models. You can't create assets directly from
	//   this type of asset model.
	AssetModelType AssetModelType

	// The external ID of the asset model. For more information, see [Using external IDs] in the IoT
	// SiteWise User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	ExternalId *string
	// contains filtered or unexported fields
}

Contains a summary of an asset model.

type AssetModelType 

type AssetModelType string
const (
	AssetModelTypeAssetModel     AssetModelType = "ASSET_MODEL"
	AssetModelTypeComponentModel AssetModelType = "COMPONENT_MODEL"
)

Enum values for AssetModelType

func (AssetModelType) Values 

func (AssetModelType) Values() []AssetModelType

Values returns all known values for AssetModelType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AssetProperty 

type AssetProperty struct {

	// The data type of the asset property.
	//
	// This member is required.
	DataType PropertyDataType

	// The ID of the asset property.
	//
	// This member is required.
	Id *string

	// The name of the property.
	//
	// This member is required.
	Name *string

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature ). For more
	// information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide.
	//
	// [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
	Alias *string

	// The data type of the structure for this property. This parameter exists on
	// properties that have the STRUCT data type.
	DataTypeSpec *string

	// The external ID of the asset property. For more information, see [Using external IDs] in the IoT
	// SiteWise User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	ExternalId *string

	// The asset property's notification topic and state. For more information, see [UpdateAssetProperty].
	//
	// [UpdateAssetProperty]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
	Notification *PropertyNotification

	// The structured path to the property from the root of the asset.
	Path []AssetPropertyPathSegment

	// The unit (such as Newtons or RPM ) of the asset property.
	Unit *string
	// contains filtered or unexported fields
}

Contains asset property information.

type AssetPropertyPathSegment 

type AssetPropertyPathSegment struct {

	// The ID of the path segment.
	Id *string

	// The name of the path segment.
	Name *string
	// contains filtered or unexported fields
}

Represents one level between a property and the root of the asset.

type AssetPropertySummary 

type AssetPropertySummary struct {

	// The ID of the property.
	//
	// This member is required.
	Id *string

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature ). For more
	// information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide.
	//
	// [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
	Alias *string

	//  The ID of the composite model that contains the asset property.
	AssetCompositeModelId *string

	// The external ID of the property. For more information, see [Using external IDs] in the IoT SiteWise
	// User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	ExternalId *string

	// Contains asset property value notification information. When the notification
	// state is enabled, IoT SiteWise publishes property value updates to a unique MQTT
	// topic. For more information, see [Interacting with other services]in the IoT SiteWise User Guide.
	//
	// [Interacting with other services]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html
	Notification *PropertyNotification

	// The structured path to the property from the root of the asset.
	Path []AssetPropertyPathSegment

	//  The unit of measure (such as Newtons or RPM) of the asset property.
	Unit *string
	// contains filtered or unexported fields
}

Contains a summary of a property associated with an asset.

type AssetPropertyValue 

type AssetPropertyValue struct {

	// The timestamp of the asset property value.
	//
	// This member is required.
	Timestamp *TimeInNanos

	// The value of the asset property (see Variant ).
	//
	// This member is required.
	Value *Variant

	// The quality of the asset property value.
	Quality Quality
	// contains filtered or unexported fields
}

Contains asset property value information.

type AssetRelationshipSummary 

type AssetRelationshipSummary struct {

	// The relationship type of the assets in this relationship. This value is one of
	// the following:
	//
	//   - HIERARCHY – The assets are related through an asset hierarchy. If you
	//   specify this relationship type, this asset relationship includes the
	//   hierarchyInfo object.
	//
	// This member is required.
	RelationshipType AssetRelationshipType

	// The assets that are related through an asset hierarchy.
	//
	// This object is present if the relationshipType is HIERARCHY .
	HierarchyInfo *AssetHierarchyInfo
	// contains filtered or unexported fields
}

Contains information about assets that are related to one another.

type AssetRelationshipType 

type AssetRelationshipType string
const (
	AssetRelationshipTypeHierarchy AssetRelationshipType = "HIERARCHY"
)

Enum values for AssetRelationshipType

func (AssetRelationshipType) Values 

func (AssetRelationshipType) Values() []AssetRelationshipType

Values returns all known values for AssetRelationshipType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

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

func (AssetState) Values 

func (AssetState) Values() []AssetState

Values returns all known values for AssetState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AssetStatus 

type AssetStatus struct {

	// The current status of the asset.
	//
	// This member is required.
	State AssetState

	// Contains associated error information, if any.
	Error *ErrorDetails
	// contains filtered or unexported fields
}

Contains information about the current status of an asset. For more information, see Asset and model statesin the IoT SiteWise User Guide.

type AssetSummary 

type AssetSummary struct {

	// The [ARN] of the asset, which has the following format.
	//
	//     arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
	//
	// [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	Arn *string

	// The ID of the asset model used to create this asset.
	//
	// This member is required.
	AssetModelId *string

	// The date the asset was created, in Unix epoch time.
	//
	// This member is required.
	CreationDate *time.Time

	// A list of asset hierarchies that each contain a hierarchyId . A hierarchy
	// specifies allowed parent/child asset relationships.
	//
	// This member is required.
	Hierarchies []AssetHierarchy

	// The ID of the asset, in UUID format.
	//
	// This member is required.
	Id *string

	// The date the asset was last updated, in Unix epoch time.
	//
	// This member is required.
	LastUpdateDate *time.Time

	// The name of the asset.
	//
	// This member is required.
	Name *string

	// The current status of the asset.
	//
	// This member is required.
	Status *AssetStatus

	// A description for the asset.
	Description *string

	// The external ID of the asset. For more information, see [Using external IDs] in the IoT SiteWise
	// User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	ExternalId *string
	// contains filtered or unexported fields
}

Contains a summary of an asset.

type AssociatedAssetsSummary 

type AssociatedAssetsSummary struct {

	// The [ARN] of the asset, which has the following format.
	//
	//     arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
	//
	// [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	Arn *string

	// The ID of the asset model used to create the asset.
	//
	// This member is required.
	AssetModelId *string

	// The date the asset was created, in Unix epoch time.
	//
	// This member is required.
	CreationDate *time.Time

	// A list of asset hierarchies that each contain a hierarchyId . A hierarchy
	// specifies allowed parent/child asset relationships.
	//
	// This member is required.
	Hierarchies []AssetHierarchy

	// The ID of the asset, in UUID format.
	//
	// This member is required.
	Id *string

	// The date the asset was last updated, in Unix epoch time.
	//
	// This member is required.
	LastUpdateDate *time.Time

	// The name of the asset.
	//
	// This member is required.
	Name *string

	// The current status of the asset.
	//
	// This member is required.
	Status *AssetStatus

	// A description for the asset.
	Description *string

	// The external ID of the asset. For more information, see [Using external IDs] in the IoT SiteWise
	// User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	ExternalId *string
	// contains filtered or unexported fields
}

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]in the
	// IoT SiteWise User Guide.
	//
	// [Updating attribute values]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-attribute-values.html
	DefaultValue *string
	// contains filtered or unexported fields
}

Contains an asset attribute property. For more information, see Attributes in the IoT SiteWise User Guide.

type AuthMode 

type AuthMode string
const (
	AuthModeIam AuthMode = "IAM"
	AuthModeSso AuthMode = "SSO"
)

Enum values for AuthMode

func (AuthMode) Values 

func (AuthMode) Values() []AuthMode

Values returns all known values for AuthMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BatchEntryCompletionStatus 

type BatchEntryCompletionStatus string
const (
	BatchEntryCompletionStatusSuccess BatchEntryCompletionStatus = "SUCCESS"
	BatchEntryCompletionStatusError   BatchEntryCompletionStatus = "ERROR"
)

Enum values for BatchEntryCompletionStatus

func (BatchEntryCompletionStatus) Values 

func (BatchEntryCompletionStatus) Values() []BatchEntryCompletionStatus

Values returns all known values for BatchEntryCompletionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BatchGetAssetPropertyAggregatesEntry 

type BatchGetAssetPropertyAggregatesEntry struct {

	// The data aggregating function.
	//
	// This member is required.
	AggregateTypes []AggregateType

	// The inclusive end of the range from which to query historical data, expressed
	// in seconds in Unix epoch time.
	//
	// This member is required.
	EndDate *time.Time

	// The ID of the entry.
	//
	// This member is required.
	EntryId *string

	// The time interval over which to aggregate data.
	//
	// This member is required.
	Resolution *string

	// The exclusive start of the range from which to query historical data, expressed
	// in seconds in Unix epoch time.
	//
	// This member is required.
	StartDate *time.Time

	// The ID of the asset in which the asset property was created.
	AssetId *string

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature ). For more
	// information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide.
	//
	// [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
	PropertyAlias *string

	// The ID of the asset property, in UUID format.
	PropertyId *string

	// The quality by which to filter asset data.
	Qualities []Quality

	// The chronological sorting order of the requested information.
	//
	// Default: ASCENDING
	TimeOrdering TimeOrdering
	// contains filtered or unexported fields
}

Contains information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregatesAPI.

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

  • The assetId and propertyId of an asset property.

  • A propertyAlias , which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature ). To define an asset property's alias, see UpdateAssetProperty.

type BatchGetAssetPropertyAggregatesErrorCode 

type BatchGetAssetPropertyAggregatesErrorCode string
const (
	BatchGetAssetPropertyAggregatesErrorCodeResourceNotFoundException BatchGetAssetPropertyAggregatesErrorCode = "ResourceNotFoundException"
	BatchGetAssetPropertyAggregatesErrorCodeInvalidRequestException   BatchGetAssetPropertyAggregatesErrorCode = "InvalidRequestException"
	BatchGetAssetPropertyAggregatesErrorCodeAccessDeniedException     BatchGetAssetPropertyAggregatesErrorCode = "AccessDeniedException"
)

Enum values for BatchGetAssetPropertyAggregatesErrorCode

func (BatchGetAssetPropertyAggregatesErrorCode) Values 

func (BatchGetAssetPropertyAggregatesErrorCode) Values() []BatchGetAssetPropertyAggregatesErrorCode

Values returns all known values for BatchGetAssetPropertyAggregatesErrorCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BatchGetAssetPropertyAggregatesErrorEntry 

type BatchGetAssetPropertyAggregatesErrorEntry struct {

	// The ID of the entry.
	//
	// This member is required.
	EntryId *string

	// The error code.
	//
	// This member is required.
	ErrorCode BatchGetAssetPropertyAggregatesErrorCode

	// The associated error message.
	//
	// This member is required.
	ErrorMessage *string
	// contains filtered or unexported fields
}

Contains error information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregatesAPI.

type BatchGetAssetPropertyAggregatesErrorInfo 

type BatchGetAssetPropertyAggregatesErrorInfo struct {

	// The error code.
	//
	// This member is required.
	ErrorCode BatchGetAssetPropertyAggregatesErrorCode

	// The date the error occurred, in Unix epoch time.
	//
	// This member is required.
	ErrorTimestamp *time.Time
	// contains filtered or unexported fields
}

Contains the error code and the timestamp for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregatesAPI.

type BatchGetAssetPropertyAggregatesSkippedEntry 

type BatchGetAssetPropertyAggregatesSkippedEntry struct {

	// The completion status of each entry that is associated with the [BatchGetAssetPropertyAggregates] API.
	//
	// [BatchGetAssetPropertyAggregates]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
	//
	// This member is required.
	CompletionStatus BatchEntryCompletionStatus

	// The ID of the entry.
	//
	// This member is required.
	EntryId *string

	// The error information, such as the error code and the timestamp.
	ErrorInfo *BatchGetAssetPropertyAggregatesErrorInfo
	// contains filtered or unexported fields
}

Contains information for an entry that has been processed by the previous BatchGetAssetPropertyAggregates request.

type BatchGetAssetPropertyAggregatesSuccessEntry 

type BatchGetAssetPropertyAggregatesSuccessEntry struct {

	// The requested aggregated asset property values (for example, average, minimum,
	// and maximum).
	//
	// This member is required.
	AggregatedValues []AggregatedValue

	// The ID of the entry.
	//
	// This member is required.
	EntryId *string
	// contains filtered or unexported fields
}

Contains success information for an entry that is associated with the BatchGetAssetPropertyAggregates API.

type BatchGetAssetPropertyValueEntry 

type BatchGetAssetPropertyValueEntry struct {

	// The ID of the entry.
	//
	// This member is required.
	EntryId *string

	// The ID of the asset in which the asset property was created.
	AssetId *string

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature ). For more
	// information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide.
	//
	// [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
	PropertyAlias *string

	// The ID of the asset property, in UUID format.
	PropertyId *string
	// contains filtered or unexported fields
}

Contains information for an asset property value entry that is associated with the BatchGetAssetPropertyValueAPI.

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

  • The assetId and propertyId of an asset property.

  • A propertyAlias , which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature ). To define an asset property's alias, see UpdateAssetProperty.

type BatchGetAssetPropertyValueErrorCode 

type BatchGetAssetPropertyValueErrorCode string
const (
	BatchGetAssetPropertyValueErrorCodeResourceNotFoundException BatchGetAssetPropertyValueErrorCode = "ResourceNotFoundException"
	BatchGetAssetPropertyValueErrorCodeInvalidRequestException   BatchGetAssetPropertyValueErrorCode = "InvalidRequestException"
	BatchGetAssetPropertyValueErrorCodeAccessDeniedException     BatchGetAssetPropertyValueErrorCode = "AccessDeniedException"
)

Enum values for BatchGetAssetPropertyValueErrorCode

func (BatchGetAssetPropertyValueErrorCode) Values 

func (BatchGetAssetPropertyValueErrorCode) Values() []BatchGetAssetPropertyValueErrorCode

Values returns all known values for BatchGetAssetPropertyValueErrorCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BatchGetAssetPropertyValueErrorEntry 

type BatchGetAssetPropertyValueErrorEntry struct {

	// The ID of the entry.
	//
	// This member is required.
	EntryId *string

	// The error code.
	//
	// This member is required.
	ErrorCode BatchGetAssetPropertyValueErrorCode

	// The associated error message.
	//
	// This member is required.
	ErrorMessage *string
	// contains filtered or unexported fields
}

Contains error information for an asset property value entry that is associated with the BatchGetAssetPropertyValueAPI.

type BatchGetAssetPropertyValueErrorInfo 

type BatchGetAssetPropertyValueErrorInfo struct {

	// The error code.
	//
	// This member is required.
	ErrorCode BatchGetAssetPropertyValueErrorCode

	// The date the error occurred, in Unix epoch time.
	//
	// This member is required.
	ErrorTimestamp *time.Time
	// contains filtered or unexported fields
}

The error information, such as the error code and the timestamp.

type BatchGetAssetPropertyValueHistoryEntry 

type BatchGetAssetPropertyValueHistoryEntry struct {

	// The ID of the entry.
	//
	// This member is required.
	EntryId *string

	// The ID of the asset in which the asset property was created.
	AssetId *string

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

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature ). For more
	// information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide.
	//
	// [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
	PropertyAlias *string

	// The ID of the asset property, in UUID format.
	PropertyId *string

	// The quality by which to filter asset data.
	Qualities []Quality

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

	// The chronological sorting order of the requested information.
	//
	// Default: ASCENDING
	TimeOrdering TimeOrdering
	// contains filtered or unexported fields
}

Contains information for an asset property historical value entry that is associated with the BatchGetAssetPropertyValueHistoryAPI.

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

  • The assetId and propertyId of an asset property.

  • A propertyAlias , which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature ). To define an asset property's alias, see UpdateAssetProperty.

type BatchGetAssetPropertyValueHistoryErrorCode 

type BatchGetAssetPropertyValueHistoryErrorCode string
const (
	BatchGetAssetPropertyValueHistoryErrorCodeResourceNotFoundException BatchGetAssetPropertyValueHistoryErrorCode = "ResourceNotFoundException"
	BatchGetAssetPropertyValueHistoryErrorCodeInvalidRequestException   BatchGetAssetPropertyValueHistoryErrorCode = "InvalidRequestException"
	BatchGetAssetPropertyValueHistoryErrorCodeAccessDeniedException     BatchGetAssetPropertyValueHistoryErrorCode = "AccessDeniedException"
)

Enum values for BatchGetAssetPropertyValueHistoryErrorCode

func (BatchGetAssetPropertyValueHistoryErrorCode) Values 

func (BatchGetAssetPropertyValueHistoryErrorCode) Values() []BatchGetAssetPropertyValueHistoryErrorCode

Values returns all known values for BatchGetAssetPropertyValueHistoryErrorCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BatchGetAssetPropertyValueHistoryErrorEntry 

type BatchGetAssetPropertyValueHistoryErrorEntry struct {

	// The ID of the entry.
	//
	// This member is required.
	EntryId *string

	// The error code.
	//
	// This member is required.
	ErrorCode BatchGetAssetPropertyValueHistoryErrorCode

	// The associated error message.
	//
	// This member is required.
	ErrorMessage *string
	// contains filtered or unexported fields
}

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

type BatchGetAssetPropertyValueHistoryErrorInfo 

type BatchGetAssetPropertyValueHistoryErrorInfo struct {

	// The error code.
	//
	// This member is required.
	ErrorCode BatchGetAssetPropertyValueHistoryErrorCode

	// The date the error occurred, in Unix epoch time.
	//
	// This member is required.
	ErrorTimestamp *time.Time
	// contains filtered or unexported fields
}

The error information, such as the error code and the timestamp.

type BatchGetAssetPropertyValueHistorySkippedEntry 

type BatchGetAssetPropertyValueHistorySkippedEntry struct {

	// The completion status of each entry that is associated with the [BatchGetAssetPropertyValueHistory] API.
	//
	// [BatchGetAssetPropertyValueHistory]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValueHistory.html
	//
	// This member is required.
	CompletionStatus BatchEntryCompletionStatus

	// The ID of the entry.
	//
	// This member is required.
	EntryId *string

	// The error information, such as the error code and the timestamp.
	ErrorInfo *BatchGetAssetPropertyValueHistoryErrorInfo
	// contains filtered or unexported fields
}

Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValueHistory request.

type BatchGetAssetPropertyValueHistorySuccessEntry 

type BatchGetAssetPropertyValueHistorySuccessEntry struct {

	// The requested historical values for the specified asset property.
	//
	// This member is required.
	AssetPropertyValueHistory []AssetPropertyValue

	// The ID of the entry.
	//
	// This member is required.
	EntryId *string
	// contains filtered or unexported fields
}

Contains success information for an entry that is associated with the BatchGetAssetPropertyValueHistory API.

type BatchGetAssetPropertyValueSkippedEntry 

type BatchGetAssetPropertyValueSkippedEntry struct {

	// The completion status of each entry that is associated with the [BatchGetAssetPropertyValue] request.
	//
	// [BatchGetAssetPropertyValue]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
	//
	// This member is required.
	CompletionStatus BatchEntryCompletionStatus

	// The ID of the entry.
	//
	// This member is required.
	EntryId *string

	// The error information, such as the error code and the timestamp.
	ErrorInfo *BatchGetAssetPropertyValueErrorInfo
	// contains filtered or unexported fields
}

Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValue request.

type BatchGetAssetPropertyValueSuccessEntry 

type BatchGetAssetPropertyValueSuccessEntry struct {

	// The ID of the entry.
	//
	// This member is required.
	EntryId *string

	// Contains asset property value information.
	AssetPropertyValue *AssetPropertyValue
	// contains filtered or unexported fields
}

Contains success information for an entry that is associated with the BatchGetAssetPropertyValue API.

type BatchPutAssetPropertyError 

type BatchPutAssetPropertyError struct {

	// The error code.
	//
	// This member is required.
	ErrorCode BatchPutAssetPropertyValueErrorCode

	// The associated error message.
	//
	// This member is required.
	ErrorMessage *string

	// A list of timestamps for each error, if any.
	//
	// This member is required.
	Timestamps []TimeInNanos
	// contains filtered or unexported fields
}

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

type BatchPutAssetPropertyErrorEntry 

type BatchPutAssetPropertyErrorEntry struct {

	// The ID of the failed entry.
	//
	// This member is required.
	EntryId *string

	// The list of update property value errors.
	//
	// This member is required.
	Errors []BatchPutAssetPropertyError
	// contains filtered or unexported fields
}

Contains error information for asset property value entries that are associated with the BatchPutAssetPropertyValueAPI.

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

func (BatchPutAssetPropertyValueErrorCode) Values 

func (BatchPutAssetPropertyValueErrorCode) Values() []BatchPutAssetPropertyValueErrorCode

Values returns all known values for BatchPutAssetPropertyValueErrorCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CapabilitySyncStatus 

type CapabilitySyncStatus string
const (
	CapabilitySyncStatusInSync     CapabilitySyncStatus = "IN_SYNC"
	CapabilitySyncStatusOutOfSync  CapabilitySyncStatus = "OUT_OF_SYNC"
	CapabilitySyncStatusSyncFailed CapabilitySyncStatus = "SYNC_FAILED"
	CapabilitySyncStatusUnknown    CapabilitySyncStatus = "UNKNOWN"
)

Enum values for CapabilitySyncStatus

func (CapabilitySyncStatus) Values 

func (CapabilitySyncStatus) Values() []CapabilitySyncStatus

Values returns all known values for CapabilitySyncStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ColumnInfo 

type ColumnInfo struct {

	// The name of the column description.
	Name *string

	// The type of the column description.
	Type *ColumnType
	// contains filtered or unexported fields
}

A description of the column in the query results.

type ColumnName 

type ColumnName string
const (
	ColumnNameAlias               ColumnName = "ALIAS"
	ColumnNameAssetId             ColumnName = "ASSET_ID"
	ColumnNamePropertyId          ColumnName = "PROPERTY_ID"
	ColumnNameDataType            ColumnName = "DATA_TYPE"
	ColumnNameTimestampSeconds    ColumnName = "TIMESTAMP_SECONDS"
	ColumnNameTimestampNanoOffset ColumnName = "TIMESTAMP_NANO_OFFSET"
	ColumnNameQuality             ColumnName = "QUALITY"
	ColumnNameValue               ColumnName = "VALUE"
)

Enum values for ColumnName

func (ColumnName) Values 

func (ColumnName) Values() []ColumnName

Values returns all known values for ColumnName. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ColumnType 

type ColumnType struct {

	// The allowed data types that the column has as it's value.
	ScalarType ScalarType
	// contains filtered or unexported fields
}

The data type of the column.

type CompositeModelProperty 

type CompositeModelProperty struct {

	// Contains asset property information.
	//
	// This member is required.
	AssetProperty *Property

	// The name of the property.
	//
	// This member is required.
	Name *string

	// The type of the composite model that defines this property.
	//
	// This member is required.
	Type *string

	// The external ID of the composite model that contains the property. For more
	// information, see [Using external IDs]in the IoT SiteWise User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	ExternalId *string

	//  The ID of the composite model that contains the property.
	Id *string
	// contains filtered or unexported fields
}

Contains information about a composite model property on an asset.

type CompositionDetails 

type CompositionDetails struct {

	// An array detailing the composition relationship for this composite model.
	CompositionRelationship []CompositionRelationshipItem
	// contains filtered or unexported fields
}

Metadata for the composition relationship established by using composedAssetModelId in CreateAssetModelCompositeModelCreateAssetModelCompositeModel .

type CompositionRelationshipItem 

type CompositionRelationshipItem struct {

	// The ID of the component.
	Id *string
	// contains filtered or unexported fields
}

Represents a composite model that composed an asset model of type COMPONENT_MODEL .

type CompositionRelationshipSummary 

type CompositionRelationshipSummary struct {

	// The ID of a composite model on this asset model.
	//
	// This member is required.
	AssetModelCompositeModelId *string

	// The composite model type. Valid values are AWS/ALARM , CUSTOM , or
	// AWS/L4E_ANOMALY .
	//
	// This member is required.
	AssetModelCompositeModelType *string

	// The ID of the asset model, in UUID format.
	//
	// This member is required.
	AssetModelId *string
	// contains filtered or unexported fields
}

Contains a summary of the components of the composite model.

type ComputeLocation 

type ComputeLocation string
const (
	ComputeLocationEdge  ComputeLocation = "EDGE"
	ComputeLocationCloud ComputeLocation = "CLOUD"
)

Enum values for ComputeLocation

func (ComputeLocation) Values 

func (ComputeLocation) Values() []ComputeLocation

Values returns all known values for ComputeLocation. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConfigurationErrorDetails 

type ConfigurationErrorDetails struct {

	// The error code.
	//
	// This member is required.
	Code ErrorCode

	// The error message.
	//
	// This member is required.
	Message *string
	// contains filtered or unexported fields
}

Contains the details of an IoT SiteWise configuration error.

type ConfigurationState 

type ConfigurationState string
const (
	ConfigurationStateActive           ConfigurationState = "ACTIVE"
	ConfigurationStateUpdateInProgress ConfigurationState = "UPDATE_IN_PROGRESS"
	ConfigurationStateUpdateFailed     ConfigurationState = "UPDATE_FAILED"
)

Enum values for ConfigurationState

func (ConfigurationState) Values 

func (ConfigurationState) Values() []ConfigurationState

Values returns all known values for ConfigurationState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConfigurationStatus 

type ConfigurationStatus struct {

	// The current state of the configuration.
	//
	// This member is required.
	State ConfigurationState

	// Contains associated error information, if any.
	Error *ConfigurationErrorDetails
	// contains filtered or unexported fields
}

Contains current status information for the configuration.

type ConflictingOperationException 

type ConflictingOperationException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId  *string
	ResourceArn *string
	// contains filtered or unexported fields
}

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 (e *ConflictingOperationException) Error() string

func (*ConflictingOperationException) ErrorCode 

func (e *ConflictingOperationException) ErrorCode() string

func (*ConflictingOperationException) ErrorFault 

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

func (*ConflictingOperationException) ErrorMessage 

func (e *ConflictingOperationException) ErrorMessage() string

type Csv 

type Csv struct {

	// The column names specified in the .csv file.
	//
	// This member is required.
	ColumnNames []ColumnName
	// contains filtered or unexported fields
}

A .CSV file.

type CustomerManagedS3Storage 

type CustomerManagedS3Storage struct {

	// The [ARN] of the Identity and Access Management role that allows IoT SiteWise to
	// send data to Amazon S3.
	//
	// [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	RoleArn *string

	// The [ARN] of the Amazon S3 object. For more information about how to find the ARN
	// for an Amazon S3 object, see [Amazon S3 resources]in the Amazon Simple Storage Service User Guide.
	//
	// [Amazon S3 resources]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-arn-format.html
	// [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	S3ResourceArn *string
	// contains filtered or unexported fields
}

Contains information about a customer managed Amazon S3 bucket.

type DashboardSummary 

type DashboardSummary struct {

	// The ID of the dashboard.
	//
	// This member is required.
	Id *string

	// The name of the dashboard
	//
	// This member is required.
	Name *string

	// The date the dashboard was created, in Unix epoch time.
	CreationDate *time.Time

	// The dashboard's description.
	Description *string

	// The date the dashboard was last updated, in Unix epoch time.
	LastUpdateDate *time.Time
	// contains filtered or unexported fields
}

Contains a dashboard summary.

type Datum 

type Datum struct {

	// Indicates if the data point is an array.
	ArrayValue []Datum

	// Indicates if the data point is null.
	NullValue *bool

	// Indicates if the data point is a row.
	RowValue *Row

	// Indicates if the data point is a scalar value such as integer, string, double,
	// or Boolean.
	ScalarValue *string
	// contains filtered or unexported fields
}

Represents a single data point in a query result.

type DetailedError 

type DetailedError struct {

	// The error code.
	//
	// This member is required.
	Code DetailedErrorCode

	// The error message.
	//
	// This member is required.
	Message *string
	// contains filtered or unexported fields
}

Contains detailed error information.

type DetailedErrorCode 

type DetailedErrorCode string
const (
	DetailedErrorCodeIncompatibleComputeLocation         DetailedErrorCode = "INCOMPATIBLE_COMPUTE_LOCATION"
	DetailedErrorCodeIncompatibleForwardingConfiguration DetailedErrorCode = "INCOMPATIBLE_FORWARDING_CONFIGURATION"
)

Enum values for DetailedErrorCode

func (DetailedErrorCode) Values 

func (DetailedErrorCode) Values() []DetailedErrorCode

Values returns all known values for DetailedErrorCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DisassociatedDataStorageState 

type DisassociatedDataStorageState string
const (
	DisassociatedDataStorageStateEnabled  DisassociatedDataStorageState = "ENABLED"
	DisassociatedDataStorageStateDisabled DisassociatedDataStorageState = "DISABLED"
)

Enum values for DisassociatedDataStorageState

func (DisassociatedDataStorageState) Values 

func (DisassociatedDataStorageState) Values() []DisassociatedDataStorageState

Values returns all known values for DisassociatedDataStorageState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EncryptionType 

type EncryptionType string
const (
	EncryptionTypeSitewiseDefaultEncryption EncryptionType = "SITEWISE_DEFAULT_ENCRYPTION"
	EncryptionTypeKmsBasedEncryption        EncryptionType = "KMS_BASED_ENCRYPTION"
)

Enum values for EncryptionType

func (EncryptionType) Values 

func (EncryptionType) Values() []EncryptionType

Values returns all known values for EncryptionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ErrorCode 

type ErrorCode string
const (
	ErrorCodeValidationError ErrorCode = "VALIDATION_ERROR"
	ErrorCodeInternalFailure ErrorCode = "INTERNAL_FAILURE"
)

Enum values for ErrorCode

func (ErrorCode) Values 

func (ErrorCode) Values() []ErrorCode

Values returns all known values for ErrorCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ErrorDetails 

type ErrorDetails struct {

	// The error code.
	//
	// This member is required.
	Code ErrorCode

	// The error message.
	//
	// This member is required.
	Message *string

	//  A list of detailed errors.
	Details []DetailedError
	// contains filtered or unexported fields
}

Contains the details of an IoT SiteWise error.

type ErrorReportLocation 

type ErrorReportLocation struct {

	// The name of the Amazon S3 bucket to which errors associated with the bulk
	// import job are sent.
	//
	// This member is required.
	Bucket *string

	// Amazon S3 uses the prefix as a folder name to organize data in the bucket. Each
	// Amazon S3 object has a key that is its unique identifier in the bucket. Each
	// object in a bucket has exactly one key. The prefix must end with a forward slash
	// (/). For more information, see [Organizing objects using prefixes]in the Amazon Simple Storage Service User Guide.
	//
	// [Organizing objects using prefixes]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html
	//
	// This member is required.
	Prefix *string
	// contains filtered or unexported fields
}

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

type ExpressionVariable 

type ExpressionVariable struct {

	// The friendly name of the variable to be used in the expression.
	//
	// This member is required.
	Name *string

	// The variable that identifies an asset property from which to use values.
	//
	// This member is required.
	Value *VariableValue
	// contains filtered or unexported fields
}

Contains expression variable information.

type File 

type File struct {

	// The name of the Amazon S3 bucket from which data is imported.
	//
	// This member is required.
	Bucket *string

	// The key of the Amazon S3 object that contains your data. Each object has a key
	// that is a unique identifier. Each object has exactly one key.
	//
	// This member is required.
	Key *string

	// The version ID to identify a specific version of the Amazon S3 object that
	// contains your data.
	VersionId *string
	// contains filtered or unexported fields
}

The file in Amazon S3 where your data is saved.

type FileFormat 

type FileFormat struct {

	// The file is in .CSV format.
	Csv *Csv

	// The file is in parquet format.
	Parquet *Parquet
	// contains filtered or unexported fields
}

The file format of the data in S3.

type ForwardingConfig 

type ForwardingConfig struct {

	// The forwarding state for the given property.
	//
	// This member is required.
	State ForwardingConfigState
	// contains filtered or unexported fields
}

The forwarding configuration for a given property.

type ForwardingConfigState 

type ForwardingConfigState string
const (
	ForwardingConfigStateDisabled ForwardingConfigState = "DISABLED"
	ForwardingConfigStateEnabled  ForwardingConfigState = "ENABLED"
)

Enum values for ForwardingConfigState

func (ForwardingConfigState) Values 

func (ForwardingConfigState) Values() []ForwardingConfigState

Values returns all known values for ForwardingConfigState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type GatewayCapabilitySummary 

type GatewayCapabilitySummary struct {

	// The namespace of the capability configuration. For example, if you configure
	// OPC-UA sources from the IoT SiteWise console, your OPC-UA capability
	// configuration has the namespace iotsitewise:opcuacollector:version , where
	// version is a number such as 1 .
	//
	// This member is required.
	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.
	//
	// This member is required.
	CapabilitySyncStatus CapabilitySyncStatus
	// contains filtered or unexported fields
}

Contains a summary of a gateway capability configuration.

type GatewayPlatform 

type GatewayPlatform struct {

	// A gateway that runs on IoT Greengrass.
	Greengrass *Greengrass

	// A gateway that runs on IoT Greengrass V2.
	GreengrassV2 *GreengrassV2
	// contains filtered or unexported fields
}

Contains a gateway's platform information.

type GatewaySummary 

type GatewaySummary struct {

	// The date the gateway was created, in Unix epoch time.
	//
	// This member is required.
	CreationDate *time.Time

	// The ID of the gateway device.
	//
	// This member is required.
	GatewayId *string

	// The name of the asset.
	//
	// This member is required.
	GatewayName *string

	// The date the gateway was last updated, in Unix epoch time.
	//
	// This member is required.
	LastUpdateDate *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].
	//
	// [DescribeGatewayCapabilityConfiguration]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html
	GatewayCapabilitySummaries []GatewayCapabilitySummary

	// Contains a gateway's platform information.
	GatewayPlatform *GatewayPlatform
	// contains filtered or unexported fields
}

Contains a summary of a gateway.

type Greengrass 

type Greengrass struct {

	// The [ARN] of the Greengrass group. For more information about how to find a group's
	// ARN, see [ListGroups]and [GetGroup] in the IoT Greengrass API Reference.
	//
	// [GetGroup]: https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html
	// [ListGroups]: https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html
	// [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	GroupArn *string
	// contains filtered or unexported fields
}

Contains details for a gateway that runs on IoT Greengrass. To create a gateway that runs on 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 IoT SiteWise. For more information, see Ingesting data using a gatewayin the IoT SiteWise User Guide.

type GreengrassV2 

type GreengrassV2 struct {

	// The name of the IoT thing for your IoT Greengrass V2 core device.
	//
	// This member is required.
	CoreDeviceThingName *string
	// contains filtered or unexported fields
}

Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass V2, you must deploy the IoT SiteWise Edge component to your gateway device. Your Greengrass device rolemust use the AWSIoTSiteWiseEdgeAccess policy. For more information, see Using IoT SiteWise at the edgein the IoT SiteWise User Guide.

type GroupIdentity 

type GroupIdentity struct {

	// The IAM Identity Center ID of the group.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

Contains information for a group identity in an access policy.

type IAMRoleIdentity 

type IAMRoleIdentity struct {

	// The ARN of the IAM role. For more information, see [IAM ARNs] in the IAM User Guide.
	//
	// [IAM ARNs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

Contains information about an Identity and Access Management role. For more information, see IAM rolesin the IAM User Guide.

type IAMUserIdentity 

type IAMUserIdentity struct {

	// The ARN of the IAM user. For more information, see [IAM ARNs] in the IAM User Guide.
	//
	// If you delete the IAM user, access policies that contain this identity include
	// an empty arn . You can delete the access policy for the IAM user that no longer
	// exists.
	//
	// [IAM ARNs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html
	//
	// This member is required.
	Arn *string
	// contains filtered or unexported fields
}

Contains information about an Identity and Access Management user.

type Identity 

type Identity struct {

	// An IAM Identity Center group identity.
	Group *GroupIdentity

	// An IAM role identity.
	IamRole *IAMRoleIdentity

	// An IAM user identity.
	IamUser *IAMUserIdentity

	// An IAM Identity Center user identity.
	User *UserIdentity
	// contains filtered or unexported fields
}

Contains an identity that can access an IoT SiteWise Monitor resource.

Currently, you can't use Amazon Web Services API operations to retrieve IAM Identity Center identity IDs. You can find the IAM Identity Center identity IDs in the URL of user and group pages in the IAM Identity Center console.

type IdentityType 

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

Enum values for IdentityType

func (IdentityType) Values 

func (IdentityType) Values() []IdentityType

Values returns all known values for IdentityType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Image 

type Image struct {

	// Contains an image file.
	File *ImageFile

	// The ID of an existing image. Specify this parameter to keep an existing image.
	Id *string
	// contains filtered or unexported fields
}

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.

type ImageFile 

type ImageFile struct {

	// The image file contents, represented as a base64-encoded string. The file size
	// must be less than 1 MB.
	//
	// This member is required.
	Data []byte

	// The file type of the image.
	//
	// This member is required.
	Type ImageFileType
	// contains filtered or unexported fields
}

Contains an image file.

type ImageFileType 

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

Enum values for ImageFileType

func (ImageFileType) Values 

func (ImageFileType) Values() []ImageFileType

Values returns all known values for ImageFileType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ImageLocation 

type ImageLocation struct {

	// The ID of the image.
	//
	// This member is required.
	Id *string

	// The URL where the image is available. The URL is valid for 15 minutes so that
	// you can view and download the image
	//
	// This member is required.
	Url *string
	// contains filtered or unexported fields
}

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

type InternalFailureException 

type InternalFailureException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

type InterpolatedAssetPropertyValue 

type InterpolatedAssetPropertyValue struct {

	// Contains a timestamp with optional nanosecond granularity.
	//
	// This member is required.
	Timestamp *TimeInNanos

	// Contains an asset property value (of a single type only).
	//
	// This member is required.
	Value *Variant
	// contains filtered or unexported fields
}

Contains information about an interpolated asset property value.

type InvalidRequestException 

type InvalidRequestException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

type JobConfiguration 

type JobConfiguration struct {

	// The file format of the data in S3.
	//
	// This member is required.
	FileFormat *FileFormat
	// contains filtered or unexported fields
}

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

type JobStatus 

type JobStatus string
const (
	JobStatusPending               JobStatus = "PENDING"
	JobStatusCancelled             JobStatus = "CANCELLED"
	JobStatusRunning               JobStatus = "RUNNING"
	JobStatusCompleted             JobStatus = "COMPLETED"
	JobStatusFailed                JobStatus = "FAILED"
	JobStatusCompletedWithFailures JobStatus = "COMPLETED_WITH_FAILURES"
)

Enum values for JobStatus

func (JobStatus) Values 

func (JobStatus) Values() []JobStatus

Values returns all known values for JobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type JobSummary 

type JobSummary struct {

	// The ID of the job.
	//
	// This member is required.
	Id *string

	// The unique name that helps identify the job request.
	//
	// This member is required.
	Name *string

	// The status of the bulk import job can be one of following values:
	//
	//   - PENDING – IoT SiteWise is waiting for the current bulk import job to finish.
	//
	//   - CANCELLED – The bulk import job has been canceled.
	//
	//   - RUNNING – IoT SiteWise is processing your request to import your data from
	//   Amazon S3.
	//
	//   - COMPLETED – IoT SiteWise successfully completed your request to import data
	//   from Amazon S3.
	//
	//   - FAILED – IoT SiteWise couldn't process your request to import data from
	//   Amazon S3. You can use logs saved in the specified error report location in
	//   Amazon S3 to troubleshoot issues.
	//
	//   - COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data
	//   from Amazon S3 with errors. You can use logs saved in the specified error report
	//   location in Amazon S3 to troubleshoot issues.
	//
	// This member is required.
	Status JobStatus
	// contains filtered or unexported fields
}

Contains the job summary information.

type LimitExceededException 

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 in the 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

type ListAssetModelPropertiesFilter 

type ListAssetModelPropertiesFilter string
const (
	ListAssetModelPropertiesFilterAll  ListAssetModelPropertiesFilter = "ALL"
	ListAssetModelPropertiesFilterBase ListAssetModelPropertiesFilter = "BASE"
)

Enum values for ListAssetModelPropertiesFilter

func (ListAssetModelPropertiesFilter) Values 

func (ListAssetModelPropertiesFilter) Values() []ListAssetModelPropertiesFilter

Values returns all known values for ListAssetModelPropertiesFilter. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ListAssetPropertiesFilter 

type ListAssetPropertiesFilter string
const (
	ListAssetPropertiesFilterAll  ListAssetPropertiesFilter = "ALL"
	ListAssetPropertiesFilterBase ListAssetPropertiesFilter = "BASE"
)

Enum values for ListAssetPropertiesFilter

func (ListAssetPropertiesFilter) Values 

func (ListAssetPropertiesFilter) Values() []ListAssetPropertiesFilter

Values returns all known values for ListAssetPropertiesFilter. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ListAssetsFilter 

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

Enum values for ListAssetsFilter

func (ListAssetsFilter) Values 

func (ListAssetsFilter) Values() []ListAssetsFilter

Values returns all known values for ListAssetsFilter. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ListBulkImportJobsFilter 

type ListBulkImportJobsFilter string
const (
	ListBulkImportJobsFilterAll                   ListBulkImportJobsFilter = "ALL"
	ListBulkImportJobsFilterPending               ListBulkImportJobsFilter = "PENDING"
	ListBulkImportJobsFilterRunning               ListBulkImportJobsFilter = "RUNNING"
	ListBulkImportJobsFilterCancelled             ListBulkImportJobsFilter = "CANCELLED"
	ListBulkImportJobsFilterFailed                ListBulkImportJobsFilter = "FAILED"
	ListBulkImportJobsFilterCompletedWithFailures ListBulkImportJobsFilter = "COMPLETED_WITH_FAILURES"
	ListBulkImportJobsFilterCompleted             ListBulkImportJobsFilter = "COMPLETED"
)

Enum values for ListBulkImportJobsFilter

func (ListBulkImportJobsFilter) Values 

func (ListBulkImportJobsFilter) Values() []ListBulkImportJobsFilter

Values returns all known values for ListBulkImportJobsFilter. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ListTimeSeriesType 

type ListTimeSeriesType string
const (
	ListTimeSeriesTypeAssociated    ListTimeSeriesType = "ASSOCIATED"
	ListTimeSeriesTypeDisassociated ListTimeSeriesType = "DISASSOCIATED"
)

Enum values for ListTimeSeriesType

func (ListTimeSeriesType) Values 

func (ListTimeSeriesType) Values() []ListTimeSeriesType

Values returns all known values for ListTimeSeriesType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LoggingLevel 

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

Enum values for LoggingLevel

func (LoggingLevel) Values 

func (LoggingLevel) Values() []LoggingLevel

Values returns all known values for LoggingLevel. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LoggingOptions 

type LoggingOptions struct {

	// The IoT SiteWise logging verbosity level.
	//
	// This member is required.
	Level LoggingLevel
	// contains filtered or unexported fields
}

Contains logging options.

type Measurement 

type Measurement struct {

	// The processing configuration for the given measurement property. You can
	// configure measurements to be kept at the edge or forwarded to the Amazon Web
	// Services Cloud. By default, measurements are forwarded to the cloud.
	ProcessingConfig *MeasurementProcessingConfig
	// contains filtered or unexported fields
}

Contains an asset measurement property. For more information, see Measurements in the IoT SiteWise User Guide.

type MeasurementProcessingConfig 

type MeasurementProcessingConfig struct {

	// The forwarding configuration for the given measurement property.
	//
	// This member is required.
	ForwardingConfig *ForwardingConfig
	// contains filtered or unexported fields
}

The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.

type Metric 

type Metric struct {

	// 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] in the IoT SiteWise User Guide.
	//
	// [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
	//
	// This member is required.
	Expression *string

	// The list of variables used in the expression.
	//
	// This member is required.
	Variables []ExpressionVariable

	// The window (time interval) over which IoT SiteWise computes the metric's
	// aggregation expression. IoT SiteWise computes one data point per window .
	//
	// This member is required.
	Window *MetricWindow

	// The processing configuration for the given metric property. You can configure
	// metrics to be computed at the edge or in the Amazon Web Services Cloud. By
	// default, metrics are forwarded to the cloud.
	ProcessingConfig *MetricProcessingConfig
	// contains filtered or unexported fields
}

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 in the IoT SiteWise User Guide.

type MetricProcessingConfig 

type MetricProcessingConfig struct {

	// The compute location for the given metric property.
	//
	// This member is required.
	ComputeLocation ComputeLocation
	// contains filtered or unexported fields
}

The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.

type MetricWindow 

type MetricWindow struct {

	// The tumbling time interval window.
	Tumbling *TumblingWindow
	// contains filtered or unexported fields
}

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

type MonitorErrorCode 

type MonitorErrorCode string
const (
	MonitorErrorCodeInternalFailure MonitorErrorCode = "INTERNAL_FAILURE"
	MonitorErrorCodeValidationError MonitorErrorCode = "VALIDATION_ERROR"
	MonitorErrorCodeLimitExceeded   MonitorErrorCode = "LIMIT_EXCEEDED"
)

Enum values for MonitorErrorCode

func (MonitorErrorCode) Values 

func (MonitorErrorCode) Values() []MonitorErrorCode

Values returns all known values for MonitorErrorCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MonitorErrorDetails 

type MonitorErrorDetails struct {

	// The error code.
	Code MonitorErrorCode

	// The error message.
	Message *string
	// contains filtered or unexported fields
}

Contains IoT SiteWise Monitor error details.

type MultiLayerStorage 

type MultiLayerStorage struct {

	// Contains information about a customer managed Amazon S3 bucket.
	//
	// This member is required.
	CustomerManagedS3Storage *CustomerManagedS3Storage
	// contains filtered or unexported fields
}

Contains information about the storage destination.

type Parquet 

type Parquet struct {
	// contains filtered or unexported fields
}

A parquet file.

type Permission 

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

Enum values for Permission

func (Permission) Values 

func (Permission) Values() []Permission

Values returns all known values for Permission. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PortalResource 

type PortalResource struct {

	// The ID of the portal.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

Identifies an 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

func (PortalState) Values 

func (PortalState) Values() []PortalState

Values returns all known values for PortalState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PortalStatus 

type PortalStatus struct {

	// The current state of the portal.
	//
	// This member is required.
	State PortalState

	// Contains associated error information, if any.
	Error *MonitorErrorDetails
	// contains filtered or unexported fields
}

Contains information about the current status of a portal.

type PortalSummary 

type PortalSummary struct {

	// The ID of the portal.
	//
	// This member is required.
	Id *string

	// The name of the portal.
	//
	// This member is required.
	Name *string

	// The URL for the IoT SiteWise Monitor portal. You can use this URL to access
	// portals that use IAM Identity Center for authentication. For portals that use
	// IAM for authentication, you must use the IoT SiteWise console to get a URL that
	// you can use to access the portal.
	//
	// This member is required.
	StartUrl *string

	// Contains information about the current status of a portal.
	//
	// This member is required.
	Status *PortalStatus

	// The date the portal was created, in Unix epoch time.
	CreationDate *time.Time

	// The portal's description.
	Description *string

	// The date the portal was last updated, in Unix epoch time.
	LastUpdateDate *time.Time

	// The [ARN] of the service role that allows the portal's users to access your IoT
	// SiteWise resources on your behalf. For more information, see [Using service roles for IoT SiteWise Monitor]in the IoT
	// SiteWise User Guide.
	//
	// [Using service roles for IoT SiteWise Monitor]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html
	// [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	RoleArn *string
	// contains filtered or unexported fields
}

Contains a portal summary.

type ProjectResource 

type ProjectResource struct {

	// The ID of the project.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

Identifies a specific IoT SiteWise Monitor project.

type ProjectSummary 

type ProjectSummary struct {

	// The ID of the project.
	//
	// This member is required.
	Id *string

	// The name of the project.
	//
	// This member is required.
	Name *string

	// The date the project was created, in Unix epoch time.
	CreationDate *time.Time

	// The project's description.
	Description *string

	// The date the project was last updated, in Unix epoch time.
	LastUpdateDate *time.Time
	// contains filtered or unexported fields
}

Contains project summary information.

type Property 

type Property struct {

	// The property data type.
	//
	// This member is required.
	DataType PropertyDataType

	// The ID of the asset property.
	//
	// This member is required.
	Id *string

	// The name of the property.
	//
	// This member is required.
	Name *string

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature ). For more
	// information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide.
	//
	// [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
	Alias *string

	// The external ID of the asset property. For more information, see [Using external IDs] in the IoT
	// SiteWise User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	ExternalId *string

	// The asset property's notification topic and state. For more information, see [UpdateAssetProperty].
	//
	// [UpdateAssetProperty]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
	Notification *PropertyNotification

	// The structured path to the property from the root of the asset.
	Path []AssetPropertyPathSegment

	// The property type (see PropertyType ). A property contains one type.
	Type *PropertyType

	// The unit (such as Newtons or RPM ) of the asset property.
	Unit *string
	// contains filtered or unexported fields
}

Contains asset property information.

type PropertyDataType 

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

Enum values for PropertyDataType

func (PropertyDataType) Values 

func (PropertyDataType) Values() []PropertyDataType

Values returns all known values for PropertyDataType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PropertyNotification 

type PropertyNotification struct {

	// The current notification state.
	//
	// This member is required.
	State PropertyNotificationState

	// The MQTT topic to which IoT SiteWise publishes property value update
	// notifications.
	//
	// This member is required.
	Topic *string
	// contains filtered or unexported fields
}

Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other servicesin the IoT SiteWise User Guide.

type PropertyNotificationState 

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

Enum values for PropertyNotificationState

func (PropertyNotificationState) Values 

func (PropertyNotificationState) Values() []PropertyNotificationState

Values returns all known values for PropertyNotificationState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PropertyType 

type PropertyType struct {

	// Specifies an asset attribute property. An attribute generally contains static
	// information, such as the serial number of an [IIoT]wind turbine.
	//
	// [IIoT]: https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications
	Attribute *Attribute

	// 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 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 filtered or unexported fields
}

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

type PutAssetPropertyValueEntry 

type PutAssetPropertyValueEntry struct {

	// The user specified ID for the entry. You can use this ID to identify which
	// entries failed.
	//
	// This member is required.
	EntryId *string

	// The list of property values to upload. You can specify up to 10 propertyValues
	// array elements.
	//
	// This member is required.
	PropertyValues []AssetPropertyValue

	// The ID of the asset to update.
	AssetId *string

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature ). For more
	// information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide.
	//
	// [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
	PropertyAlias *string

	// The ID of the asset property for this entry.
	PropertyId *string
	// contains filtered or unexported fields
}

Contains a list of value updates for an asset property in the list of asset entries consumed by the BatchPutAssetPropertyValueAPI operation.

type Quality 

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

Enum values for Quality

func (Quality) Values 

func (Quality) Values() []Quality

Values returns all known values for Quality. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QueryTimeoutException 

type QueryTimeoutException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The query timed out.

func (*QueryTimeoutException) Error 

func (e *QueryTimeoutException) Error() string

func (*QueryTimeoutException) ErrorCode 

func (e *QueryTimeoutException) ErrorCode() string

func (*QueryTimeoutException) ErrorFault 

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

func (*QueryTimeoutException) ErrorMessage 

func (e *QueryTimeoutException) ErrorMessage() string

type Resource 

type Resource struct {

	// A portal resource.
	Portal *PortalResource

	// A project resource.
	Project *ProjectResource
	// contains filtered or unexported fields
}

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

type ResourceAlreadyExistsException 

type ResourceAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId  *string
	ResourceArn *string
	// contains filtered or unexported fields
}

The resource already exists.

func (*ResourceAlreadyExistsException) Error 

func (e *ResourceAlreadyExistsException) Error() string

func (*ResourceAlreadyExistsException) ErrorCode 

func (e *ResourceAlreadyExistsException) ErrorCode() string

func (*ResourceAlreadyExistsException) ErrorFault 

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

func (*ResourceAlreadyExistsException) ErrorMessage 

func (e *ResourceAlreadyExistsException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceType 

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

Enum values for ResourceType

func (ResourceType) Values 

func (ResourceType) Values() []ResourceType

Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RetentionPeriod 

type RetentionPeriod struct {

	// The number of days that your data is kept.
	//
	// If you specified a value for this parameter, the unlimited parameter must be
	// false .
	NumberOfDays *int32

	// If true, your data is kept indefinitely.
	//
	// If configured to true , you must not specify a value for the numberOfDays
	// parameter.
	Unlimited *bool
	// contains filtered or unexported fields
}

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

type Row 

type Row struct {

	// List of data points in a single row of the result set.
	//
	// This member is required.
	Data []Datum
	// contains filtered or unexported fields
}

Represents a single row in the query results.

type ScalarType 

type ScalarType string
const (
	ScalarTypeBoolean   ScalarType = "BOOLEAN"
	ScalarTypeInt       ScalarType = "INT"
	ScalarTypeDouble    ScalarType = "DOUBLE"
	ScalarTypeTimestamp ScalarType = "TIMESTAMP"
	ScalarTypeString    ScalarType = "STRING"
)

Enum values for ScalarType

func (ScalarType) Values 

func (ScalarType) Values() []ScalarType

Values returns all known values for ScalarType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ServiceUnavailableException 

type ServiceUnavailableException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The requested service is unavailable.

func (*ServiceUnavailableException) Error 

func (e *ServiceUnavailableException) Error() string

func (*ServiceUnavailableException) ErrorCode 

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault 

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

func (*ServiceUnavailableException) ErrorMessage 

func (e *ServiceUnavailableException) ErrorMessage() string

type StorageType 

type StorageType string
const (
	StorageTypeSitewiseDefaultStorage StorageType = "SITEWISE_DEFAULT_STORAGE"
	StorageTypeMultiLayerStorage      StorageType = "MULTI_LAYER_STORAGE"
)

Enum values for StorageType

func (StorageType) Values 

func (StorageType) Values() []StorageType

Values returns all known values for StorageType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TargetResource 

type TargetResource struct {

	// The ID of the asset, in UUID format.
	//
	// This member is required.
	AssetId *string
	// contains filtered or unexported fields
}

The resource the action will be taken on.

type TargetResourceType 

type TargetResourceType string
const (
	TargetResourceTypeAsset TargetResourceType = "ASSET"
)

Enum values for TargetResourceType

func (TargetResourceType) Values 

func (TargetResourceType) Values() []TargetResourceType

Values returns all known values for TargetResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the 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

type TimeInNanos 

type TimeInNanos struct {

	// The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond
	// data is provided by offsetInNanos .
	//
	// This member is required.
	TimeInSeconds *int64

	// The nanosecond offset from timeInSeconds .
	OffsetInNanos *int32
	// contains filtered or unexported fields
}

Contains a timestamp with optional nanosecond granularity.

type TimeOrdering 

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

Enum values for TimeOrdering

func (TimeOrdering) Values 

func (TimeOrdering) Values() []TimeOrdering

Values returns all known values for TimeOrdering. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TimeSeriesSummary 

type TimeSeriesSummary struct {

	// The data type of the time series.
	//
	// If you specify STRUCT , you must also specify dataTypeSpec to identify the type
	// of the structure for this time series.
	//
	// This member is required.
	DataType PropertyDataType

	// The [ARN] of the time series, which has the following format.
	//
	//     arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
	//
	// [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	TimeSeriesArn *string

	// The date that the time series was created, in Unix epoch time.
	//
	// This member is required.
	TimeSeriesCreationDate *time.Time

	// The ID of the time series.
	//
	// This member is required.
	TimeSeriesId *string

	// The date that the time series was last updated, in Unix epoch time.
	//
	// This member is required.
	TimeSeriesLastUpdateDate *time.Time

	// The alias that identifies the time series.
	Alias *string

	// The ID of the asset in which the asset property was created.
	AssetId *string

	// The data type of the structure for this time series. This parameter is required
	// for time series that have the STRUCT data type.
	//
	// The options for this parameter depend on the type of the composite model in
	// which you created the asset property that is associated with your time series.
	// Use AWS/ALARM_STATE for alarm state in alarm composite models.
	DataTypeSpec *string

	// The ID of the asset property, in UUID format.
	PropertyId *string
	// contains filtered or unexported fields
}

Contains a summary of a time series (data stream).

type TooManyTagsException 

type TooManyTagsException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceName *string
	// contains filtered or unexported fields
}

You've reached the limit for the number of tags allowed for a resource. For more information, see Tag naming limits and requirementsin the Amazon Web Services 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

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] in the IoT SiteWise User Guide.
	//
	// [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
	//
	// This member is required.
	Expression *string

	// The list of variables used in the expression.
	//
	// This member is required.
	Variables []ExpressionVariable

	// The processing configuration for the given transform property. You can
	// configure transforms to be kept at the edge or forwarded to the Amazon Web
	// Services Cloud. You can also configure transforms to be computed at the edge or
	// in the cloud.
	ProcessingConfig *TransformProcessingConfig
	// contains filtered or unexported fields
}

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 in the IoT SiteWise User Guide.

type TransformProcessingConfig 

type TransformProcessingConfig struct {

	// The compute location for the given transform property.
	//
	// This member is required.
	ComputeLocation ComputeLocation

	// The forwarding configuration for a given property.
	ForwardingConfig *ForwardingConfig
	// contains filtered or unexported fields
}

The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.

type TraversalDirection 

type TraversalDirection string
const (
	TraversalDirectionParent TraversalDirection = "PARENT"
	TraversalDirectionChild  TraversalDirection = "CHILD"
)

Enum values for TraversalDirection

func (TraversalDirection) Values 

func (TraversalDirection) Values() []TraversalDirection

Values returns all known values for TraversalDirection. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TraversalType 

type TraversalType string
const (
	TraversalTypePathToRoot TraversalType = "PATH_TO_ROOT"
)

Enum values for TraversalType

func (TraversalType) Values 

func (TraversalType) Values() []TraversalType

Values returns all known values for TraversalType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TumblingWindow 

type TumblingWindow struct {

	// The time interval for the tumbling window. The interval time must be between 1
	// minute and 1 week.
	//
	// 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 IoT SiteWise aggregates data points for metric computations, the start of
	// each interval is exclusive and the end of each interval is inclusive. IoT
	// SiteWise places the computed data point at the end of the interval.
	//
	// This member is required.
	Interval *string

	// The offset for the tumbling window. The offset parameter accepts the following:
	//
	//   - The offset time.
	//
	// For example, if you specify 18h for offset and 1d for interval , IoT SiteWise
	//   aggregates data in one of the following ways:
	//
	//   - If you create the metric before or at 6 PM (UTC), you get the first
	//   aggregation result at 6 PM (UTC) on the day when you create the metric.
	//
	//   - If you create the metric after 6 PM (UTC), you get the first aggregation
	//   result at 6 PM (UTC) the next day.
	//
	//   - The ISO 8601 format.
	//
	// For example, if you specify PT18H for offset and 1d for interval , IoT SiteWise
	//   aggregates data in one of the following ways:
	//
	//   - If you create the metric before or at 6 PM (UTC), you get the first
	//   aggregation result at 6 PM (UTC) on the day when you create the metric.
	//
	//   - If you create the metric after 6 PM (UTC), you get the first aggregation
	//   result at 6 PM (UTC) the next day.
	//
	//   - The 24-hour clock.
	//
	// For example, if you specify 00:03:00 for offset , 5m for interval , and you
	//   create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM
	//   (UTC). You get the second aggregation result at 2:08 PM (UTC).
	//
	//   - The offset time zone.
	//
	// For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval ,
	//   IoT SiteWise aggregates data in one of the following ways:
	//
	//   - If you create the metric before or at 6 PM (PST), you get the first
	//   aggregation result at 6 PM (PST) on the day when you create the metric.
	//
	//   - If you create the metric after 6 PM (PST), you get the first aggregation
	//   result at 6 PM (PST) the next day.
	Offset *string
	// contains filtered or unexported fields
}

Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time window. You can use this window in metrics to aggregate data from properties and other assets.

You can use m , h , d , and w when you specify an interval or offset. Note that m represents minutes, h represents hours, d represents days, and w represents weeks. You can also use s to represent seconds in offset .

The interval and offset parameters support the ISO 8601 format. For example, PT5S represents 5 seconds, PT5M represents 5 minutes, and PT5H represents 5 hours.

type UnauthorizedException 

type UnauthorizedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You are not authorized.

func (*UnauthorizedException) Error 

func (e *UnauthorizedException) Error() string

func (*UnauthorizedException) ErrorCode 

func (e *UnauthorizedException) ErrorCode() string

func (*UnauthorizedException) ErrorFault 

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

func (*UnauthorizedException) ErrorMessage 

func (e *UnauthorizedException) ErrorMessage() string

type UserIdentity 

type UserIdentity struct {

	// The IAM Identity Center ID of the user.
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

Contains information for a user identity in an access policy.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The validation failed for this query.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

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

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type VariableValue 

type VariableValue struct {

	// The ID of the hierarchy to query for the property ID. You can use the
	// hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external
	// ID, you can specify externalId: followed by the external ID. For more
	// information, see [Using external IDs]in the IoT SiteWise User Guide.
	//
	// 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]in the IoT SiteWise User Guide.
	//
	// [Asset hierarchies]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	HierarchyId *string

	// The ID of the property to use as the variable. You can use the property name if
	// it's from the same asset model. If the property has an external ID, you can
	// specify externalId: followed by the external ID. For more information, see [Using external IDs] in
	// the IoT SiteWise User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	PropertyId *string

	// The path of the property.
	PropertyPath []AssetModelPropertyPathSegment
	// contains filtered or unexported fields
}

Identifies a property value used in an expression.

type Variant 

type Variant struct {

	// Asset property data of type Boolean (true or false).
	BooleanValue *bool

	// Asset property data of type double (floating point number).
	DoubleValue *float64

	// Asset property data of type integer (number that's greater than or equal to
	// zero).
	IntegerValue *int32

	// Asset property data of type string (sequence of characters).
	StringValue *string
	// contains filtered or unexported fields
}

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

type WarmTierRetentionPeriod 

type WarmTierRetentionPeriod struct {

	// The number of days the data is stored in the warm tier.
	NumberOfDays *int32

	// If set to true, the data is stored indefinitely in the warm tier.
	Unlimited *bool
	// contains filtered or unexported fields
}

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

type WarmTierState 

type WarmTierState string
const (
	WarmTierStateEnabled  WarmTierState = "ENABLED"
	WarmTierStateDisabled WarmTierState = "DISABLED"
)

Enum values for WarmTierState

func (WarmTierState) Values 

func (WarmTierState) Values() []WarmTierState

Values returns all known values for WarmTierState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.