package types
import "github.com/aws/aws-sdk-go-v2/service/iotsitewise/types"
Index ¶
- type AccessPolicySummary
- type AggregateType
- type AggregatedValue
- type Aggregates
- type AssetErrorCode
- type AssetErrorDetails
- type AssetHierarchy
- type AssetModelHierarchy
- type AssetModelHierarchyDefinition
- type AssetModelProperty
- type AssetModelPropertyDefinition
- type AssetModelState
- type AssetModelStatus
- type AssetModelSummary
- type AssetProperty
- type AssetPropertyValue
- type AssetState
- type AssetStatus
- type AssetSummary
- type AssociatedAssetsSummary
- type Attribute
- type AuthMode
- type BatchPutAssetPropertyError
- type BatchPutAssetPropertyErrorEntry
- type BatchPutAssetPropertyValueErrorCode
- type CapabilitySyncStatus
- type ConflictingOperationException
- func (e *ConflictingOperationException) Error() string
- func (e *ConflictingOperationException) ErrorCode() string
- func (e *ConflictingOperationException) ErrorFault() smithy.ErrorFault
- func (e *ConflictingOperationException) ErrorMessage() string
- type DashboardSummary
- type ErrorCode
- type ErrorDetails
- type ExpressionVariable
- type GatewayCapabilitySummary
- type GatewayPlatform
- type GatewaySummary
- type Greengrass
- type GroupIdentity
- type IAMUserIdentity
- type Identity
- type IdentityType
- type Image
- type ImageFile
- type ImageFileType
- type ImageLocation
- type InternalFailureException
- func (e *InternalFailureException) Error() string
- func (e *InternalFailureException) ErrorCode() string
- func (e *InternalFailureException) ErrorFault() smithy.ErrorFault
- func (e *InternalFailureException) ErrorMessage() string
- type InvalidRequestException
- func (e *InvalidRequestException) Error() string
- func (e *InvalidRequestException) ErrorCode() string
- func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault
- func (e *InvalidRequestException) ErrorMessage() string
- type LimitExceededException
- func (e *LimitExceededException) Error() string
- func (e *LimitExceededException) ErrorCode() string
- func (e *LimitExceededException) ErrorFault() smithy.ErrorFault
- func (e *LimitExceededException) ErrorMessage() string
- type ListAssetsFilter
- type LoggingLevel
- type LoggingOptions
- type Measurement
- type Metric
- type MetricWindow
- type MonitorErrorCode
- type MonitorErrorDetails
- type Permission
- type PortalResource
- type PortalState
- type PortalStatus
- type PortalSummary
- type ProjectResource
- type ProjectSummary
- type Property
- type PropertyDataType
- type PropertyNotification
- type PropertyNotificationState
- type PropertyType
- type PutAssetPropertyValueEntry
- type Quality
- type Resource
- type ResourceAlreadyExistsException
- func (e *ResourceAlreadyExistsException) Error() string
- func (e *ResourceAlreadyExistsException) ErrorCode() string
- func (e *ResourceAlreadyExistsException) ErrorFault() smithy.ErrorFault
- func (e *ResourceAlreadyExistsException) ErrorMessage() string
- type ResourceNotFoundException
- func (e *ResourceNotFoundException) Error() string
- func (e *ResourceNotFoundException) ErrorCode() string
- func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
- func (e *ResourceNotFoundException) ErrorMessage() string
- type ResourceType
- type ServiceUnavailableException
- func (e *ServiceUnavailableException) Error() string
- func (e *ServiceUnavailableException) ErrorCode() string
- func (e *ServiceUnavailableException) ErrorFault() smithy.ErrorFault
- func (e *ServiceUnavailableException) ErrorMessage() string
- type ThrottlingException
- func (e *ThrottlingException) Error() string
- func (e *ThrottlingException) ErrorCode() string
- func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
- func (e *ThrottlingException) ErrorMessage() string
- type TimeInNanos
- type TimeOrdering
- type TooManyTagsException
- func (e *TooManyTagsException) Error() string
- func (e *TooManyTagsException) ErrorCode() string
- func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault
- func (e *TooManyTagsException) ErrorMessage() string
- type Transform
- type TraversalDirection
- type TumblingWindow
- type UserIdentity
- type VariableValue
- type Variant
Types ¶
type AccessPolicySummary ¶
type AccessPolicySummary struct { // The ID of the access policy. // // This member is required. Id *string // The identity (an AWS SSO user, an AWS SSO 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 AWS 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 an access policy that defines an identity's access to an AWS IoT SiteWise Monitor resource.
type AggregateType ¶
type AggregateType string
const ( AggregateTypeAverage AggregateType = "AVERAGE" AggregateTypeCount AggregateType = "COUNT" AggregateTypeMaximum AggregateType = "MAXIMUM" AggregateTypeMinimum AggregateType = "MINIMUM" AggregateTypeSum AggregateType = "SUM" 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 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 the (pre-calculated) aggregate values for an asset property.
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. // // 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 error details for the requested associate project asset action.
type AssetHierarchy ¶
type AssetHierarchy struct { // The hierarchy name provided in the CreateAssetModel // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) // or UpdateAssetModel // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) // API operation. // // This member is required. Name *string // The ID of the hierarchy. This ID is a hierarchyId. Id *string }
Describes an asset hierarchy that contains a hierarchy's name and ID.
type AssetModelHierarchy ¶
type AssetModelHierarchy struct { // The ID of the asset model. All assets in this hierarchy must be instances of the // childAssetModelId asset model. // // This member is required. ChildAssetModelId *string // The name of the asset model hierarchy that you specify by using the // CreateAssetModel // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) // or UpdateAssetModel // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) // API operation. // // This member is required. Name *string // The ID of the asset model hierarchy. This ID is a hierarchyId. Id *string }
Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.
type AssetModelHierarchyDefinition ¶
type AssetModelHierarchyDefinition struct { // The ID of an asset model for this hierarchy. // // This member is required. ChildAssetModelId *string // The name of the asset model hierarchy definition (as specified in the // CreateAssetModel // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html) // or UpdateAssetModel // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html) // API operation). // // This member is required. Name *string }
Contains an asset model hierarchy used in asset model creation. An asset model hierarchy determines the kind (or type) of asset that can belong to a hierarchy.
type AssetModelProperty ¶
type AssetModelProperty struct { // The 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 ID of the asset model property. Id *string // The unit of the asset model property, such as Newtons or RPM. Unit *string }
Contains information about an asset model property.
type AssetModelPropertyDefinition ¶
type AssetModelPropertyDefinition struct { // The data type of the property definition. // // 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 unit of the property definition, such as Newtons or RPM. Unit *string }
Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
type AssetModelState ¶
type AssetModelState string
const ( AssetModelStateCreating AssetModelState = "CREATING" AssetModelStateActive AssetModelState = "ACTIVE" AssetModelStateUpdating AssetModelState = "UPDATING" AssetModelStatePropagating AssetModelState = "PROPAGATING" AssetModelStateDeleting AssetModelState = "DELETING" AssetModelStateFailed AssetModelState = "FAILED" )
Enum values for AssetModelState
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 current status information for an asset model. For more information, see Asset and model states (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html) in the AWS IoT SiteWise User Guide.
type AssetModelSummary ¶
type AssetModelSummary struct { // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the asset model, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId} // // 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 AWS IoT SiteWise APIs). // // 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 }
Contains a summary of an asset model.
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 property alias that identifies the property, such as an OPC-UA server data // stream path (for example, /company/windfarm/3/turbine/7/temperature). For more // information, see Mapping industrial data streams to asset properties // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the AWS IoT SiteWise User Guide. Alias *string // The asset property's notification topic and state. For more information, see // UpdateAssetProperty // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). Notification *PropertyNotification // The unit (such as Newtons or RPM) of the asset property. Unit *string }
Contains asset property information.
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 asset property value information.
type AssetState ¶
type AssetState string
const ( AssetStateCreating AssetState = "CREATING" AssetStateActive AssetState = "ACTIVE" AssetStateUpdating AssetState = "UPDATING" AssetStateDeleting AssetState = "DELETING" AssetStateFailed AssetState = "FAILED" )
Enum values for AssetState
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 information about the current status of an asset. For more information, see Asset and model states (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html) in the AWS IoT SiteWise User Guide.
type AssetSummary ¶
type AssetSummary struct { // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the asset, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} // // 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. // // 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 }
Contains a summary of an asset.
type AssociatedAssetsSummary ¶
type AssociatedAssetsSummary struct { // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the asset, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} // // 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. // // 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 }
Contains a summary of an associated asset.
type Attribute ¶
type Attribute struct { // The default value of the asset model property attribute. All assets that you // create from the asset model contain this attribute value. You can update an // attribute's value after you create an asset. For more information, see Updating // attribute values // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-attribute-values.html) // in the AWS IoT SiteWise User Guide. DefaultValue *string }
Contains an asset attribute property. For more information, see Attributes (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#attributes) in the AWS IoT SiteWise User Guide.
type AuthMode ¶
type AuthMode string
Enum values for AuthMode
func (AuthMode) Values ¶
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 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 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 error information for asset property value entries that are associated with the BatchPutAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html) API.
type BatchPutAssetPropertyValueErrorCode ¶
type BatchPutAssetPropertyValueErrorCode string
const ( BatchPutAssetPropertyValueErrorCodeResourcenotfoundexception BatchPutAssetPropertyValueErrorCode = "ResourceNotFoundException" BatchPutAssetPropertyValueErrorCodeInvalidrequestexception BatchPutAssetPropertyValueErrorCode = "InvalidRequestException" BatchPutAssetPropertyValueErrorCodeInternalfailureexception BatchPutAssetPropertyValueErrorCode = "InternalFailureException" 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" )
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 ConflictingOperationException ¶
type ConflictingOperationException struct { Message *string ResourceArn *string ResourceId *string }
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
func (*ConflictingOperationException) Error ¶
func (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 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 a dashboard summary.
type ErrorCode ¶
type ErrorCode string
const ( ErrorCodeValidationError ErrorCode = "VALIDATION_ERROR" ErrorCodeInternalFailure ErrorCode = "INTERNAL_FAILURE" )
Enum values for ErrorCode
func (ErrorCode) Values ¶
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 }
Contains the details of an AWS IoT SiteWise error.
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 expression variable information.
type GatewayCapabilitySummary ¶
type GatewayCapabilitySummary struct { // The namespace of the capability configuration. For example, if you configure // OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability // configuration has the namespace iotsitewise:opcuacollector:version, where // version is a number such as 1. // // 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 a summary of a gateway capability configuration.
type GatewayPlatform ¶
type GatewayPlatform struct { // A gateway that runs on AWS IoT Greengrass. // // This member is required. Greengrass *Greengrass }
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 // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html). GatewayCapabilitySummaries []*GatewayCapabilitySummary }
Contains a summary of a gateway.
type Greengrass ¶
type Greengrass struct { // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the Greengrass group. For more information about how to find a group's ARN, see // ListGroups // (https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html) // and GetGroup // (https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html) // in the AWS IoT Greengrass API Reference. // // This member is required. GroupArn *string }
Contains details for a gateway that runs on AWS IoT Greengrass. To create a gateway that runs on AWS IoT Greengrass, you must add the IoT SiteWise connector to a Greengrass group and deploy it. Your Greengrass group must also have permissions to upload data to AWS IoT SiteWise. For more information, see Ingesting data using a gateway (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html) in the AWS IoT SiteWise User Guide.
type GroupIdentity ¶
type GroupIdentity struct { // The AWS SSO ID of the group. // // This member is required. Id *string }
Contains information for a group identity in an access policy.
type IAMUserIdentity ¶
type IAMUserIdentity struct { // The ARN of the IAM user. IAM users must have the // iotsitewise:CreatePresignedPortalUrl permission to sign in to the portal. For // more information, see IAM ARNs // (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) 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. // // This member is required. Arn *string }
Contains information about an AWS Identity and Access Management (IAM) user.
type Identity ¶
type Identity struct { // An AWS SSO group identity. Group *GroupIdentity // An IAM user identity. IamUser *IAMUserIdentity // An AWS SSO user identity. User *UserIdentity }
Contains an identity that can access an AWS IoT SiteWise Monitor resource. Currently, you can't use AWS APIs to retrieve AWS SSO identity IDs. You can find the AWS SSO identity IDs in the URL of user and group pages in the AWS SSO console (https://console.aws.amazon.com/singlesignon).
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 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 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 an image that is uploaded to AWS IoT SiteWise and available at a URL.
type InternalFailureException ¶
type InternalFailureException struct { Message *string }
AWS IoT SiteWise can't process your request right now. Try again later.
func (*InternalFailureException) Error ¶
func (e *InternalFailureException) Error() string
func (*InternalFailureException) ErrorCode ¶
func (e *InternalFailureException) ErrorCode() string
func (*InternalFailureException) ErrorFault ¶
func (e *InternalFailureException) ErrorFault() smithy.ErrorFault
func (*InternalFailureException) ErrorMessage ¶
func (e *InternalFailureException) ErrorMessage() string
type InvalidRequestException ¶
type InvalidRequestException struct { Message *string }
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
func (*InvalidRequestException) Error ¶
func (e *InvalidRequestException) Error() string
func (*InvalidRequestException) ErrorCode ¶
func (e *InvalidRequestException) ErrorCode() string
func (*InvalidRequestException) ErrorFault ¶
func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault
func (*InvalidRequestException) ErrorMessage ¶
func (e *InvalidRequestException) ErrorMessage() string
type LimitExceededException ¶
type LimitExceededException struct { Message *string }
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model. For more information, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the AWS IoT SiteWise User Guide.
func (*LimitExceededException) Error ¶
func (e *LimitExceededException) Error() string
func (*LimitExceededException) ErrorCode ¶
func (e *LimitExceededException) ErrorCode() string
func (*LimitExceededException) ErrorFault ¶
func (e *LimitExceededException) ErrorFault() smithy.ErrorFault
func (*LimitExceededException) ErrorMessage ¶
func (e *LimitExceededException) ErrorMessage() string
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 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 AWS IoT SiteWise logging verbosity level. // // This member is required. Level LoggingLevel }
Contains logging options.
type Measurement ¶
type Measurement struct { }
Contains an asset measurement property. This structure is empty. For more information, see Measurements (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#measurements) in the AWS IoT SiteWise User Guide.
type Metric ¶
type Metric struct { // The mathematical expression that defines the metric aggregation function. You // can specify up to 10 variables per expression. You can specify up to 10 // functions per expression. For more information, see Quotas // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the // AWS IoT SiteWise User Guide. // // 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 AWS IoT SiteWise computes the metric's // aggregation expression. AWS IoT SiteWise computes one data point per window. // // This member is required. Window *MetricWindow }
Contains an asset metric property. With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum). The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a root metric can have up to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE. For more information, see Metrics (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics) in the AWS IoT SiteWise User Guide.
type MetricWindow ¶
type MetricWindow struct { // The tumbling time interval window. Tumbling *TumblingWindow }
Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).
type MonitorErrorCode ¶
type MonitorErrorCode string
const ( 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 AWS IoT SiteWise Monitor error details.
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 }
Identifies an AWS IoT SiteWise Monitor portal.
type PortalState ¶
type PortalState string
const ( PortalStateCreating PortalState = "CREATING" PortalStateUpdating PortalState = "UPDATING" PortalStateDeleting PortalState = "DELETING" PortalStateActive PortalState = "ACTIVE" PortalStateFailed PortalState = "FAILED" )
Enum values for PortalState
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 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 AWS IoT SiteWise Monitor portal. You can use this URL to access // portals that use AWS SSO for authentication. For portals that use IAM for // authentication, you must use the CreatePresignedPortalUrl // (https://docs.aws.amazon.com/AWS IoT SiteWise API // ReferenceAPI_CreatePresignedPortalUrl.html) operation to create 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 // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the service role that allows the portal's users to access your AWS IoT SiteWise // resources on your behalf. For more information, see Using service roles for AWS // IoT SiteWise Monitor // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) // in the AWS IoT SiteWise User Guide. RoleArn *string }
Contains a portal summary.
type ProjectResource ¶
type ProjectResource struct { // The ID of the project. // // This member is required. Id *string }
Identifies a specific AWS 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 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 property alias that identifies the property, such as an OPC-UA server data // stream path (for example, /company/windfarm/3/turbine/7/temperature). For more // information, see Mapping industrial data streams to asset properties // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the AWS IoT SiteWise User Guide. Alias *string // The asset property's notification topic and state. For more information, see // UpdateAssetProperty // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html). Notification *PropertyNotification // The 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 asset property information.
type PropertyDataType ¶
type PropertyDataType string
const ( PropertyDataTypeString PropertyDataType = "STRING" PropertyDataTypeInteger PropertyDataType = "INTEGER" PropertyDataTypeDouble PropertyDataType = "DOUBLE" PropertyDataTypeBoolean PropertyDataType = "BOOLEAN" )
Enum values for PropertyDataType
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 AWS IoT SiteWise publishes property value update // notifications. // // This member is required. Topic *string }
Contains asset property value notification information. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) in the AWS IoT SiteWise User Guide.
type PropertyNotificationState ¶
type PropertyNotificationState string
const ( PropertyNotificationStateEnabled PropertyNotificationState = "ENABLED" PropertyNotificationStateDisabled PropertyNotificationState = "DISABLED" )
Enum values for PropertyNotificationState
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 // (https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications) wind // turbine. 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 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 property alias that identifies the property, such as an OPC-UA server data // stream path (for example, /company/windfarm/3/turbine/7/temperature). For more // information, see Mapping industrial data streams to asset properties // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the AWS IoT SiteWise User Guide. PropertyAlias *string // The ID of the asset property for this entry. PropertyId *string }
Contains a list of value updates for an asset property in the list of asset entries consumed by the BatchPutAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html) API operation.
type Quality ¶
type Quality string
const ( QualityGood Quality = "GOOD" QualityBad Quality = "BAD" QualityUncertain Quality = "UNCERTAIN" )
Enum values for Quality
func (Quality) Values ¶
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 Resource ¶
type Resource struct { // A portal resource. Portal *PortalResource // A project resource. Project *ProjectResource }
Contains an AWS IoT SiteWise Monitor resource ID for a portal or project.
type ResourceAlreadyExistsException ¶
type ResourceAlreadyExistsException struct { Message *string ResourceId *string ResourceArn *string }
The resource already exists.
func (*ResourceAlreadyExistsException) Error ¶
func (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 }
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 ServiceUnavailableException ¶
type ServiceUnavailableException struct { string }*
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 ThrottlingException ¶
type ThrottlingException struct { Message *string }
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on. For more information, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the AWS IoT SiteWise User Guide.
func (*ThrottlingException) Error ¶
func (e *ThrottlingException) Error() string
func (*ThrottlingException) ErrorCode ¶
func (e *ThrottlingException) ErrorCode() string
func (*ThrottlingException) ErrorFault ¶
func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
func (*ThrottlingException) ErrorMessage ¶
func (e *ThrottlingException) ErrorMessage() string
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 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 TooManyTagsException ¶
You've reached the limit for the number of tags allowed for a resource. For more information, see Tag naming limits and requirements (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions) in the AWS General Reference.
func (*TooManyTagsException) Error ¶
func (e *TooManyTagsException) Error() string
func (*TooManyTagsException) ErrorCode ¶
func (e *TooManyTagsException) ErrorCode() string
func (*TooManyTagsException) ErrorFault ¶
func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault
func (*TooManyTagsException) ErrorMessage ¶
func (e *TooManyTagsException) ErrorMessage() string
type Transform ¶
type Transform struct { // The mathematical expression that defines the transformation function. You can // specify up to 10 variables per expression. You can specify up to 10 functions // per expression. For more information, see Quotas // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the // AWS IoT SiteWise User Guide. // // This member is required. Expression *string // The list of variables used in the expression. // // This member is required. Variables []*ExpressionVariable }
Contains an asset transform property. A transform is a one-to-one mapping of a property's data points from one form to another. For example, you can use a transform to convert a Celsius data stream to Fahrenheit by applying the transformation expression to each data point of the Celsius stream. A transform can only have a data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE. For more information, see Transforms (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#transforms) in the AWS IoT SiteWise User Guide.
type 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 TumblingWindow ¶
type TumblingWindow struct { // The time interval for the tumbling window. Note that w represents weeks, d // represents days, h represents hours, and m represents minutes. AWS IoT SiteWise // computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d // interval at the end of each day at midnight (UTC), the 1h interval at the end of // each hour, and so on. When AWS IoT SiteWise aggregates data points for metric // computations, the start of each interval is exclusive and the end of each // interval is inclusive. AWS IoT SiteWise places the computed data point at the // end of the interval. // // This member is required. Interval *string }
Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time interval. This window is used in metric and aggregation computations.
type UserIdentity ¶
type UserIdentity struct { // The AWS SSO ID of the user. // // This member is required. Id *string }
Contains information for a user identity in an access policy.
type VariableValue ¶
type VariableValue struct { // The ID of the property to use as the variable. You can use the property name if // it's from the same asset model. // // This member is required. PropertyId *string // The ID of the hierarchy to query for the property ID. You can use the // hierarchy's name instead of the hierarchy's ID. You use a hierarchy ID instead // of a model ID because you can have several hierarchies using the same model and // therefore the same propertyId. For example, you might have separately grouped // assets that come from the same asset model. For more information, see Asset // hierarchies // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) // in the AWS IoT SiteWise User Guide. HierarchyId *string }
Identifies a property value used in an expression.
type Variant ¶
type Variant struct { // Asset property data of type Boolean (true or false). BooleanValue *bool // Asset property data of type double (floating point number). DoubleValue *float64 // Asset property data of type integer (whole number). IntegerValue *int32 // Asset property data of type string (sequence of characters). StringValue *string }
Contains an asset property value (of a single type only).
Source Files ¶
- Version
- v0.29.0
- Published
- Oct 31, 2020
- Platform
- js/wasm
- Imports
- 3 packages
- Last checked
- 6 days ago –
Tools for package owners.