func AggregateType_Values() []string
AggregateType_Values returns all elements of the AggregateType enum
func AssetErrorCode_Values() []string
AssetErrorCode_Values returns all elements of the AssetErrorCode enum
func AssetModelState_Values() []string
AssetModelState_Values returns all elements of the AssetModelState enum
func AssetRelationshipType_Values() []string
AssetRelationshipType_Values returns all elements of the AssetRelationshipType enum
func AssetState_Values() []string
AssetState_Values returns all elements of the AssetState enum
func AuthMode_Values() []string
AuthMode_Values returns all elements of the AuthMode enum
func BatchEntryCompletionStatus_Values() []string
BatchEntryCompletionStatus_Values returns all elements of the BatchEntryCompletionStatus enum
func BatchGetAssetPropertyAggregatesErrorCode_Values() []string
BatchGetAssetPropertyAggregatesErrorCode_Values returns all elements of the BatchGetAssetPropertyAggregatesErrorCode enum
func BatchGetAssetPropertyValueErrorCode_Values() []string
BatchGetAssetPropertyValueErrorCode_Values returns all elements of the BatchGetAssetPropertyValueErrorCode enum
func BatchGetAssetPropertyValueHistoryErrorCode_Values() []string
BatchGetAssetPropertyValueHistoryErrorCode_Values returns all elements of the BatchGetAssetPropertyValueHistoryErrorCode enum
func BatchPutAssetPropertyValueErrorCode_Values() []string
BatchPutAssetPropertyValueErrorCode_Values returns all elements of the BatchPutAssetPropertyValueErrorCode enum
func CapabilitySyncStatus_Values() []string
CapabilitySyncStatus_Values returns all elements of the CapabilitySyncStatus enum
func ComputeLocation_Values() []string
ComputeLocation_Values returns all elements of the ComputeLocation enum
func ConfigurationState_Values() []string
ConfigurationState_Values returns all elements of the ConfigurationState enum
func DetailedErrorCode_Values() []string
DetailedErrorCode_Values returns all elements of the DetailedErrorCode enum
func DisassociatedDataStorageState_Values() []string
DisassociatedDataStorageState_Values returns all elements of the DisassociatedDataStorageState enum
func EncryptionType_Values() []string
EncryptionType_Values returns all elements of the EncryptionType enum
func ErrorCode_Values() []string
ErrorCode_Values returns all elements of the ErrorCode enum
func ForwardingConfigState_Values() []string
ForwardingConfigState_Values returns all elements of the ForwardingConfigState enum
func IdentityType_Values() []string
IdentityType_Values returns all elements of the IdentityType enum
func ImageFileType_Values() []string
ImageFileType_Values returns all elements of the ImageFileType enum
func ListAssetsFilter_Values() []string
ListAssetsFilter_Values returns all elements of the ListAssetsFilter enum
func ListTimeSeriesType_Values() []string
ListTimeSeriesType_Values returns all elements of the ListTimeSeriesType enum
func LoggingLevel_Values() []string
LoggingLevel_Values returns all elements of the LoggingLevel enum
func MonitorErrorCode_Values() []string
MonitorErrorCode_Values returns all elements of the MonitorErrorCode enum
func Permission_Values() []string
Permission_Values returns all elements of the Permission enum
func PortalState_Values() []string
PortalState_Values returns all elements of the PortalState enum
func PropertyDataType_Values() []string
PropertyDataType_Values returns all elements of the PropertyDataType enum
func PropertyNotificationState_Values() []string
PropertyNotificationState_Values returns all elements of the PropertyNotificationState enum
func Quality_Values() []string
Quality_Values returns all elements of the Quality enum
func ResourceType_Values() []string
ResourceType_Values returns all elements of the ResourceType enum
func StorageType_Values() []string
StorageType_Values returns all elements of the StorageType enum
func TimeOrdering_Values() []string
TimeOrdering_Values returns all elements of the TimeOrdering enum
func TraversalDirection_Values() []string
TraversalDirection_Values returns all elements of the TraversalDirection enum
func TraversalType_Values() []string
TraversalType_Values returns all elements of the TraversalType enum
type AccessPolicySummary struct { // The date the access policy was created, in Unix epoch time. CreationDate *time.Time `locationName:"creationDate" type:"timestamp"` // The ID of the access policy. // // Id is a required field Id *string `locationName:"id" min:"36" type:"string" required:"true"` // The identity (an Amazon Web Services SSO user, an Amazon Web Services SSO // group, or an IAM user). // // Identity is a required field Identity *Identity `locationName:"identity" type:"structure" required:"true"` // The date the access policy was last updated, in Unix epoch time. LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp"` // The permissions for the access policy. Note that a project ADMINISTRATOR // is also known as a project owner. // // Permission is a required field Permission *string `locationName:"permission" type:"string" required:"true" enum:"Permission"` // The IoT SiteWise Monitor resource (a portal or project). // // Resource is a required field Resource *Resource `locationName:"resource" type:"structure" required:"true"` // contains filtered or unexported fields }
Contains an access policy that defines an identity's access to an IoT SiteWise Monitor resource.
func (s AccessPolicySummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AccessPolicySummary) SetCreationDate(v time.Time) *AccessPolicySummary
SetCreationDate sets the CreationDate field's value.
func (s *AccessPolicySummary) SetId(v string) *AccessPolicySummary
SetId sets the Id field's value.
func (s *AccessPolicySummary) SetIdentity(v *Identity) *AccessPolicySummary
SetIdentity sets the Identity field's value.
func (s *AccessPolicySummary) SetLastUpdateDate(v time.Time) *AccessPolicySummary
SetLastUpdateDate sets the LastUpdateDate field's value.
func (s *AccessPolicySummary) SetPermission(v string) *AccessPolicySummary
SetPermission sets the Permission field's value.
func (s *AccessPolicySummary) SetResource(v *Resource) *AccessPolicySummary
SetResource sets the Resource field's value.
func (s AccessPolicySummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AggregatedValue struct { // The quality of the aggregated data. Quality *string `locationName:"quality" type:"string" enum:"Quality"` // The date the aggregating computations occurred, in Unix epoch time. // // Timestamp is a required field Timestamp *time.Time `locationName:"timestamp" type:"timestamp" required:"true"` // The value of the aggregates. // // Value is a required field Value *Aggregates `locationName:"value" type:"structure" required:"true"` // contains filtered or unexported fields }
Contains aggregated asset property values (for example, average, minimum, and maximum).
func (s AggregatedValue) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AggregatedValue) SetQuality(v string) *AggregatedValue
SetQuality sets the Quality field's value.
func (s *AggregatedValue) SetTimestamp(v time.Time) *AggregatedValue
SetTimestamp sets the Timestamp field's value.
func (s *AggregatedValue) SetValue(v *Aggregates) *AggregatedValue
SetValue sets the Value field's value.
func (s AggregatedValue) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Aggregates struct { // The average (mean) value of the time series over a time interval window. Average *float64 `locationName:"average" type:"double"` // The count of data points in the time series over a time interval window. Count *float64 `locationName:"count" type:"double"` // The maximum value of the time series over a time interval window. Maximum *float64 `locationName:"maximum" type:"double"` // The minimum value of the time series over a time interval window. Minimum *float64 `locationName:"minimum" type:"double"` // The standard deviation of the time series over a time interval window. StandardDeviation *float64 `locationName:"standardDeviation" type:"double"` // The sum of the time series over a time interval window. Sum *float64 `locationName:"sum" type:"double"` // contains filtered or unexported fields }
Contains the (pre-calculated) aggregate values for an asset property.
func (s Aggregates) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Aggregates) SetAverage(v float64) *Aggregates
SetAverage sets the Average field's value.
func (s *Aggregates) SetCount(v float64) *Aggregates
SetCount sets the Count field's value.
func (s *Aggregates) SetMaximum(v float64) *Aggregates
SetMaximum sets the Maximum field's value.
func (s *Aggregates) SetMinimum(v float64) *Aggregates
SetMinimum sets the Minimum field's value.
func (s *Aggregates) SetStandardDeviation(v float64) *Aggregates
SetStandardDeviation sets the StandardDeviation field's value.
func (s *Aggregates) SetSum(v float64) *Aggregates
SetSum sets the Sum field's value.
func (s Aggregates) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Alarms struct { // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of the IAM role that allows the alarm to perform actions and access Amazon // Web Services resources and services, such as IoT Events. // // AlarmRoleArn is a required field AlarmRoleArn *string `locationName:"alarmRoleArn" min:"1" type:"string" required:"true"` // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of the Lambda function that manages alarm notifications. For more information, // see Managing alarm notifications (https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) // in the IoT Events Developer Guide. NotificationLambdaArn *string `locationName:"notificationLambdaArn" min:"1" type:"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 alarms (https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) in the IoT SiteWise Application Guide.
func (s Alarms) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Alarms) SetAlarmRoleArn(v string) *Alarms
SetAlarmRoleArn sets the AlarmRoleArn field's value.
func (s *Alarms) SetNotificationLambdaArn(v string) *Alarms
SetNotificationLambdaArn sets the NotificationLambdaArn field's value.
func (s Alarms) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Alarms) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AssetCompositeModel struct { // The description of the composite model. Description *string `locationName:"description" min:"1" type:"string"` // The name of the composite model. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The asset properties that this composite model defines. // // Properties is a required field Properties []*AssetProperty `locationName:"properties" type:"list" required:"true"` // The type of the composite model. For alarm composite models, this type is // AWS/ALARM. // // Type is a required field Type *string `locationName:"type" min:"1" type:"string" required:"true"` // 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.
func (s AssetCompositeModel) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetCompositeModel) SetDescription(v string) *AssetCompositeModel
SetDescription sets the Description field's value.
func (s *AssetCompositeModel) SetName(v string) *AssetCompositeModel
SetName sets the Name field's value.
func (s *AssetCompositeModel) SetProperties(v []*AssetProperty) *AssetCompositeModel
SetProperties sets the Properties field's value.
func (s *AssetCompositeModel) SetType(v string) *AssetCompositeModel
SetType sets the Type field's value.
func (s AssetCompositeModel) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AssetErrorDetails struct { // The ID of the asset. // // AssetId is a required field AssetId *string `locationName:"assetId" min:"36" type:"string" required:"true"` // The error code. // // Code is a required field Code *string `locationName:"code" type:"string" required:"true" enum:"AssetErrorCode"` // The error message. // // Message is a required field Message *string `locationName:"message" type:"string" required:"true"` // contains filtered or unexported fields }
Contains error details for the requested associate project asset action.
func (s AssetErrorDetails) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetErrorDetails) SetAssetId(v string) *AssetErrorDetails
SetAssetId sets the AssetId field's value.
func (s *AssetErrorDetails) SetCode(v string) *AssetErrorDetails
SetCode sets the Code field's value.
func (s *AssetErrorDetails) SetMessage(v string) *AssetErrorDetails
SetMessage sets the Message field's value.
func (s AssetErrorDetails) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AssetHierarchy struct { // The ID of the hierarchy. This ID is a hierarchyId. Id *string `locationName:"id" min:"36" type:"string"` // 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. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Describes an asset hierarchy that contains a hierarchy's name and ID.
func (s AssetHierarchy) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetHierarchy) SetId(v string) *AssetHierarchy
SetId sets the Id field's value.
func (s *AssetHierarchy) SetName(v string) *AssetHierarchy
SetName sets the Name field's value.
func (s AssetHierarchy) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AssetHierarchyInfo struct { // The ID of the child asset in this asset relationship. ChildAssetId *string `locationName:"childAssetId" min:"36" type:"string"` // The ID of the parent asset in this asset relationship. ParentAssetId *string `locationName:"parentAssetId" min:"36" type:"string"` // contains filtered or unexported fields }
Contains information about a parent asset and a child asset that are related through an asset hierarchy.
func (s AssetHierarchyInfo) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetHierarchyInfo) SetChildAssetId(v string) *AssetHierarchyInfo
SetChildAssetId sets the ChildAssetId field's value.
func (s *AssetHierarchyInfo) SetParentAssetId(v string) *AssetHierarchyInfo
SetParentAssetId sets the ParentAssetId field's value.
func (s AssetHierarchyInfo) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AssetModelCompositeModel struct { // The description of the composite model. Description *string `locationName:"description" min:"1" type:"string"` // The name of the composite model. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The asset property definitions for this composite model. Properties []*AssetModelProperty `locationName:"properties" type:"list"` // The type of the composite model. For alarm composite models, this type is // AWS/ALARM. // // Type is a required field Type *string `locationName:"type" min:"1" type:"string" required:"true"` // 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.
func (s AssetModelCompositeModel) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetModelCompositeModel) SetDescription(v string) *AssetModelCompositeModel
SetDescription sets the Description field's value.
func (s *AssetModelCompositeModel) SetName(v string) *AssetModelCompositeModel
SetName sets the Name field's value.
func (s *AssetModelCompositeModel) SetProperties(v []*AssetModelProperty) *AssetModelCompositeModel
SetProperties sets the Properties field's value.
func (s *AssetModelCompositeModel) SetType(v string) *AssetModelCompositeModel
SetType sets the Type field's value.
func (s AssetModelCompositeModel) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetModelCompositeModel) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AssetModelCompositeModelDefinition struct { // The description of the composite model. Description *string `locationName:"description" min:"1" type:"string"` // The name of the composite model. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The asset property definitions for this composite model. Properties []*AssetModelPropertyDefinition `locationName:"properties" type:"list"` // The type of the composite model. For alarm composite models, this type is // AWS/ALARM. // // Type is a required field Type *string `locationName:"type" min:"1" type:"string" required:"true"` // 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.
func (s AssetModelCompositeModelDefinition) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetModelCompositeModelDefinition) SetDescription(v string) *AssetModelCompositeModelDefinition
SetDescription sets the Description field's value.
func (s *AssetModelCompositeModelDefinition) SetName(v string) *AssetModelCompositeModelDefinition
SetName sets the Name field's value.
func (s *AssetModelCompositeModelDefinition) SetProperties(v []*AssetModelPropertyDefinition) *AssetModelCompositeModelDefinition
SetProperties sets the Properties field's value.
func (s *AssetModelCompositeModelDefinition) SetType(v string) *AssetModelCompositeModelDefinition
SetType sets the Type field's value.
func (s AssetModelCompositeModelDefinition) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetModelCompositeModelDefinition) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AssetModelHierarchy struct { // The ID of the asset model. All assets in this hierarchy must be instances // of the childAssetModelId asset model. // // ChildAssetModelId is a required field ChildAssetModelId *string `locationName:"childAssetModelId" min:"36" type:"string" required:"true"` // The ID of the asset model hierarchy. This ID is a hierarchyId. Id *string `locationName:"id" min:"36" type:"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. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // 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.
func (s AssetModelHierarchy) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetModelHierarchy) SetChildAssetModelId(v string) *AssetModelHierarchy
SetChildAssetModelId sets the ChildAssetModelId field's value.
func (s *AssetModelHierarchy) SetId(v string) *AssetModelHierarchy
SetId sets the Id field's value.
func (s *AssetModelHierarchy) SetName(v string) *AssetModelHierarchy
SetName sets the Name field's value.
func (s AssetModelHierarchy) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetModelHierarchy) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AssetModelHierarchyDefinition struct { // The ID of an asset model for this hierarchy. // // ChildAssetModelId is a required field ChildAssetModelId *string `locationName:"childAssetModelId" min:"36" type:"string" required:"true"` // 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). // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // 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.
func (s AssetModelHierarchyDefinition) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetModelHierarchyDefinition) SetChildAssetModelId(v string) *AssetModelHierarchyDefinition
SetChildAssetModelId sets the ChildAssetModelId field's value.
func (s *AssetModelHierarchyDefinition) SetName(v string) *AssetModelHierarchyDefinition
SetName sets the Name field's value.
func (s AssetModelHierarchyDefinition) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetModelHierarchyDefinition) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AssetModelProperty struct { // The data type of the asset model property. // // DataType is a required field DataType *string `locationName:"dataType" type:"string" required:"true" enum:"PropertyDataType"` // The data type of the structure for this property. This parameter exists on // properties that have the STRUCT data type. DataTypeSpec *string `locationName:"dataTypeSpec" min:"1" type:"string"` // The ID of the asset model property. Id *string `locationName:"id" min:"36" type:"string"` // The name of the asset model property. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The property type (see PropertyType). // // Type is a required field Type *PropertyType `locationName:"type" type:"structure" required:"true"` // The unit of the asset model property, such as Newtons or RPM. Unit *string `locationName:"unit" min:"1" type:"string"` // contains filtered or unexported fields }
Contains information about an asset model property.
func (s AssetModelProperty) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetModelProperty) SetDataType(v string) *AssetModelProperty
SetDataType sets the DataType field's value.
func (s *AssetModelProperty) SetDataTypeSpec(v string) *AssetModelProperty
SetDataTypeSpec sets the DataTypeSpec field's value.
func (s *AssetModelProperty) SetId(v string) *AssetModelProperty
SetId sets the Id field's value.
func (s *AssetModelProperty) SetName(v string) *AssetModelProperty
SetName sets the Name field's value.
func (s *AssetModelProperty) SetType(v *PropertyType) *AssetModelProperty
SetType sets the Type field's value.
func (s *AssetModelProperty) SetUnit(v string) *AssetModelProperty
SetUnit sets the Unit field's value.
func (s AssetModelProperty) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetModelProperty) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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. // // DataType is a required field DataType *string `locationName:"dataType" type:"string" required:"true" enum:"PropertyDataType"` // 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 `locationName:"dataTypeSpec" min:"1" type:"string"` // The name of the property definition. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The property definition type (see PropertyType). You can only specify one // type in a property definition. // // Type is a required field Type *PropertyType `locationName:"type" type:"structure" required:"true"` // The unit of the property definition, such as Newtons or RPM. Unit *string `locationName:"unit" min:"1" type:"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.
func (s AssetModelPropertyDefinition) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetModelPropertyDefinition) SetDataType(v string) *AssetModelPropertyDefinition
SetDataType sets the DataType field's value.
func (s *AssetModelPropertyDefinition) SetDataTypeSpec(v string) *AssetModelPropertyDefinition
SetDataTypeSpec sets the DataTypeSpec field's value.
func (s *AssetModelPropertyDefinition) SetName(v string) *AssetModelPropertyDefinition
SetName sets the Name field's value.
func (s *AssetModelPropertyDefinition) SetType(v *PropertyType) *AssetModelPropertyDefinition
SetType sets the Type field's value.
func (s *AssetModelPropertyDefinition) SetUnit(v string) *AssetModelPropertyDefinition
SetUnit sets the Unit field's value.
func (s AssetModelPropertyDefinition) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetModelPropertyDefinition) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AssetModelStatus struct { // Contains associated error information, if any. Error *ErrorDetails `locationName:"error" type:"structure"` // The current state of the asset model. // // State is a required field State *string `locationName:"state" type:"string" required:"true" enum:"AssetModelState"` // contains filtered or unexported fields }
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 IoT SiteWise User Guide.
func (s AssetModelStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetModelStatus) SetError(v *ErrorDetails) *AssetModelStatus
SetError sets the Error field's value.
func (s *AssetModelStatus) SetState(v string) *AssetModelStatus
SetState sets the State field's value.
func (s AssetModelStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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} // // Arn is a required field Arn *string `locationName:"arn" min:"1" type:"string" required:"true"` // The date the asset model was created, in Unix epoch time. // // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"` // The asset model description. // // Description is a required field Description *string `locationName:"description" min:"1" type:"string" required:"true"` // The ID of the asset model (used with IoT SiteWise APIs). // // Id is a required field Id *string `locationName:"id" min:"36" type:"string" required:"true"` // The date the asset model was last updated, in Unix epoch time. // // LastUpdateDate is a required field LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp" required:"true"` // The name of the asset model. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The current status of the asset model. // // Status is a required field Status *AssetModelStatus `locationName:"status" type:"structure" required:"true"` // contains filtered or unexported fields }
Contains a summary of an asset model.
func (s AssetModelSummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetModelSummary) SetArn(v string) *AssetModelSummary
SetArn sets the Arn field's value.
func (s *AssetModelSummary) SetCreationDate(v time.Time) *AssetModelSummary
SetCreationDate sets the CreationDate field's value.
func (s *AssetModelSummary) SetDescription(v string) *AssetModelSummary
SetDescription sets the Description field's value.
func (s *AssetModelSummary) SetId(v string) *AssetModelSummary
SetId sets the Id field's value.
func (s *AssetModelSummary) SetLastUpdateDate(v time.Time) *AssetModelSummary
SetLastUpdateDate sets the LastUpdateDate field's value.
func (s *AssetModelSummary) SetName(v string) *AssetModelSummary
SetName sets the Name field's value.
func (s *AssetModelSummary) SetStatus(v *AssetModelStatus) *AssetModelSummary
SetStatus sets the Status field's value.
func (s AssetModelSummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AssetProperty struct { // 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. Alias *string `locationName:"alias" min:"1" type:"string"` // The data type of the asset property. // // DataType is a required field DataType *string `locationName:"dataType" type:"string" required:"true" enum:"PropertyDataType"` // The data type of the structure for this property. This parameter exists on // properties that have the STRUCT data type. DataTypeSpec *string `locationName:"dataTypeSpec" min:"1" type:"string"` // The ID of the asset property. // // Id is a required field Id *string `locationName:"id" min:"36" type:"string" required:"true"` // The name of the property. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // 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 `locationName:"notification" type:"structure"` // The unit (such as Newtons or RPM) of the asset property. Unit *string `locationName:"unit" min:"1" type:"string"` // contains filtered or unexported fields }
Contains asset property information.
func (s AssetProperty) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetProperty) SetAlias(v string) *AssetProperty
SetAlias sets the Alias field's value.
func (s *AssetProperty) SetDataType(v string) *AssetProperty
SetDataType sets the DataType field's value.
func (s *AssetProperty) SetDataTypeSpec(v string) *AssetProperty
SetDataTypeSpec sets the DataTypeSpec field's value.
func (s *AssetProperty) SetId(v string) *AssetProperty
SetId sets the Id field's value.
func (s *AssetProperty) SetName(v string) *AssetProperty
SetName sets the Name field's value.
func (s *AssetProperty) SetNotification(v *PropertyNotification) *AssetProperty
SetNotification sets the Notification field's value.
func (s *AssetProperty) SetUnit(v string) *AssetProperty
SetUnit sets the Unit field's value.
func (s AssetProperty) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AssetPropertyValue struct { // The quality of the asset property value. Quality *string `locationName:"quality" type:"string" enum:"Quality"` // The timestamp of the asset property value. // // Timestamp is a required field Timestamp *TimeInNanos `locationName:"timestamp" type:"structure" required:"true"` // The value of the asset property (see Variant). // // Value is a required field Value *Variant `locationName:"value" type:"structure" required:"true"` // contains filtered or unexported fields }
Contains asset property value information.
func (s AssetPropertyValue) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetPropertyValue) SetQuality(v string) *AssetPropertyValue
SetQuality sets the Quality field's value.
func (s *AssetPropertyValue) SetTimestamp(v *TimeInNanos) *AssetPropertyValue
SetTimestamp sets the Timestamp field's value.
func (s *AssetPropertyValue) SetValue(v *Variant) *AssetPropertyValue
SetValue sets the Value field's value.
func (s AssetPropertyValue) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetPropertyValue) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AssetRelationshipSummary struct { // The assets that are related through an asset hierarchy. // // This object is present if the relationshipType is HIERARCHY. HierarchyInfo *AssetHierarchyInfo `locationName:"hierarchyInfo" type:"structure"` // 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. // // RelationshipType is a required field RelationshipType *string `locationName:"relationshipType" type:"string" required:"true" enum:"AssetRelationshipType"` // contains filtered or unexported fields }
Contains information about assets that are related to one another.
func (s AssetRelationshipSummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetRelationshipSummary) SetHierarchyInfo(v *AssetHierarchyInfo) *AssetRelationshipSummary
SetHierarchyInfo sets the HierarchyInfo field's value.
func (s *AssetRelationshipSummary) SetRelationshipType(v string) *AssetRelationshipSummary
SetRelationshipType sets the RelationshipType field's value.
func (s AssetRelationshipSummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AssetStatus struct { // Contains associated error information, if any. Error *ErrorDetails `locationName:"error" type:"structure"` // The current status of the asset. // // State is a required field State *string `locationName:"state" type:"string" required:"true" enum:"AssetState"` // contains filtered or unexported fields }
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 IoT SiteWise User Guide.
func (s AssetStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetStatus) SetError(v *ErrorDetails) *AssetStatus
SetError sets the Error field's value.
func (s *AssetStatus) SetState(v string) *AssetStatus
SetState sets the State field's value.
func (s AssetStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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} // // Arn is a required field Arn *string `locationName:"arn" min:"1" type:"string" required:"true"` // The ID of the asset model used to create this asset. // // AssetModelId is a required field AssetModelId *string `locationName:"assetModelId" min:"36" type:"string" required:"true"` // The date the asset was created, in Unix epoch time. // // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"` // A list of asset hierarchies that each contain a hierarchyId. A hierarchy // specifies allowed parent/child asset relationships. // // Hierarchies is a required field Hierarchies []*AssetHierarchy `locationName:"hierarchies" type:"list" required:"true"` // The ID of the asset. // // Id is a required field Id *string `locationName:"id" min:"36" type:"string" required:"true"` // The date the asset was last updated, in Unix epoch time. // // LastUpdateDate is a required field LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp" required:"true"` // The name of the asset. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The current status of the asset. // // Status is a required field Status *AssetStatus `locationName:"status" type:"structure" required:"true"` // contains filtered or unexported fields }
Contains a summary of an asset.
func (s AssetSummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssetSummary) SetArn(v string) *AssetSummary
SetArn sets the Arn field's value.
func (s *AssetSummary) SetAssetModelId(v string) *AssetSummary
SetAssetModelId sets the AssetModelId field's value.
func (s *AssetSummary) SetCreationDate(v time.Time) *AssetSummary
SetCreationDate sets the CreationDate field's value.
func (s *AssetSummary) SetHierarchies(v []*AssetHierarchy) *AssetSummary
SetHierarchies sets the Hierarchies field's value.
func (s *AssetSummary) SetId(v string) *AssetSummary
SetId sets the Id field's value.
func (s *AssetSummary) SetLastUpdateDate(v time.Time) *AssetSummary
SetLastUpdateDate sets the LastUpdateDate field's value.
func (s *AssetSummary) SetName(v string) *AssetSummary
SetName sets the Name field's value.
func (s *AssetSummary) SetStatus(v *AssetStatus) *AssetSummary
SetStatus sets the Status field's value.
func (s AssetSummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AssociateAssetsInput struct { // The ID of the parent asset. // // AssetId is a required field AssetId *string `location:"uri" locationName:"assetId" min:"36" type:"string" required:"true"` // The ID of the child asset to be associated. // // ChildAssetId is a required field ChildAssetId *string `locationName:"childAssetId" min:"36" type:"string" required:"true"` // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // The ID of a hierarchy in the parent asset's model. Hierarchies allow different // groupings of assets to be formed that all come from the same asset model. // For more information, see Asset hierarchies (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) // in the IoT SiteWise User Guide. // // HierarchyId is a required field HierarchyId *string `locationName:"hierarchyId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s AssociateAssetsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssociateAssetsInput) SetAssetId(v string) *AssociateAssetsInput
SetAssetId sets the AssetId field's value.
func (s *AssociateAssetsInput) SetChildAssetId(v string) *AssociateAssetsInput
SetChildAssetId sets the ChildAssetId field's value.
func (s *AssociateAssetsInput) SetClientToken(v string) *AssociateAssetsInput
SetClientToken sets the ClientToken field's value.
func (s *AssociateAssetsInput) SetHierarchyId(v string) *AssociateAssetsInput
SetHierarchyId sets the HierarchyId field's value.
func (s AssociateAssetsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssociateAssetsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AssociateAssetsOutput struct {
// contains filtered or unexported fields
}
func (s AssociateAssetsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s AssociateAssetsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AssociateTimeSeriesToAssetPropertyInput struct { // The alias that identifies the time series. // // Alias is a required field Alias *string `location:"querystring" locationName:"alias" min:"1" type:"string" required:"true"` // The ID of the asset in which the asset property was created. // // AssetId is a required field AssetId *string `location:"querystring" locationName:"assetId" min:"36" type:"string" required:"true"` // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // The ID of the asset property. // // PropertyId is a required field PropertyId *string `location:"querystring" locationName:"propertyId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s AssociateTimeSeriesToAssetPropertyInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssociateTimeSeriesToAssetPropertyInput) SetAlias(v string) *AssociateTimeSeriesToAssetPropertyInput
SetAlias sets the Alias field's value.
func (s *AssociateTimeSeriesToAssetPropertyInput) SetAssetId(v string) *AssociateTimeSeriesToAssetPropertyInput
SetAssetId sets the AssetId field's value.
func (s *AssociateTimeSeriesToAssetPropertyInput) SetClientToken(v string) *AssociateTimeSeriesToAssetPropertyInput
SetClientToken sets the ClientToken field's value.
func (s *AssociateTimeSeriesToAssetPropertyInput) SetPropertyId(v string) *AssociateTimeSeriesToAssetPropertyInput
SetPropertyId sets the PropertyId field's value.
func (s AssociateTimeSeriesToAssetPropertyInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssociateTimeSeriesToAssetPropertyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AssociateTimeSeriesToAssetPropertyOutput struct {
// contains filtered or unexported fields
}
func (s AssociateTimeSeriesToAssetPropertyOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s AssociateTimeSeriesToAssetPropertyOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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} // // Arn is a required field Arn *string `locationName:"arn" min:"1" type:"string" required:"true"` // The ID of the asset model used to create the asset. // // AssetModelId is a required field AssetModelId *string `locationName:"assetModelId" min:"36" type:"string" required:"true"` // The date the asset was created, in Unix epoch time. // // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"` // A list of asset hierarchies that each contain a hierarchyId. A hierarchy // specifies allowed parent/child asset relationships. // // Hierarchies is a required field Hierarchies []*AssetHierarchy `locationName:"hierarchies" type:"list" required:"true"` // The ID of the asset. // // Id is a required field Id *string `locationName:"id" min:"36" type:"string" required:"true"` // The date the asset was last updated, in Unix epoch time. // // LastUpdateDate is a required field LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp" required:"true"` // The name of the asset. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The current status of the asset. // // Status is a required field Status *AssetStatus `locationName:"status" type:"structure" required:"true"` // contains filtered or unexported fields }
Contains a summary of an associated asset.
func (s AssociatedAssetsSummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AssociatedAssetsSummary) SetArn(v string) *AssociatedAssetsSummary
SetArn sets the Arn field's value.
func (s *AssociatedAssetsSummary) SetAssetModelId(v string) *AssociatedAssetsSummary
SetAssetModelId sets the AssetModelId field's value.
func (s *AssociatedAssetsSummary) SetCreationDate(v time.Time) *AssociatedAssetsSummary
SetCreationDate sets the CreationDate field's value.
func (s *AssociatedAssetsSummary) SetHierarchies(v []*AssetHierarchy) *AssociatedAssetsSummary
SetHierarchies sets the Hierarchies field's value.
func (s *AssociatedAssetsSummary) SetId(v string) *AssociatedAssetsSummary
SetId sets the Id field's value.
func (s *AssociatedAssetsSummary) SetLastUpdateDate(v time.Time) *AssociatedAssetsSummary
SetLastUpdateDate sets the LastUpdateDate field's value.
func (s *AssociatedAssetsSummary) SetName(v string) *AssociatedAssetsSummary
SetName sets the Name field's value.
func (s *AssociatedAssetsSummary) SetStatus(v *AssetStatus) *AssociatedAssetsSummary
SetStatus sets the Status field's value.
func (s AssociatedAssetsSummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 IoT SiteWise User Guide. DefaultValue *string `locationName:"defaultValue" min:"1" type:"string"` // contains filtered or unexported fields }
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 IoT SiteWise User Guide.
func (s Attribute) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Attribute) SetDefaultValue(v string) *Attribute
SetDefaultValue sets the DefaultValue field's value.
func (s Attribute) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Attribute) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchAssociateProjectAssetsInput struct { // The IDs of the assets to be associated to the project. // // AssetIds is a required field AssetIds []*string `locationName:"assetIds" min:"1" type:"list" required:"true"` // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // The ID of the project to which to associate the assets. // // ProjectId is a required field ProjectId *string `location:"uri" locationName:"projectId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s BatchAssociateProjectAssetsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchAssociateProjectAssetsInput) SetAssetIds(v []*string) *BatchAssociateProjectAssetsInput
SetAssetIds sets the AssetIds field's value.
func (s *BatchAssociateProjectAssetsInput) SetClientToken(v string) *BatchAssociateProjectAssetsInput
SetClientToken sets the ClientToken field's value.
func (s *BatchAssociateProjectAssetsInput) SetProjectId(v string) *BatchAssociateProjectAssetsInput
SetProjectId sets the ProjectId field's value.
func (s BatchAssociateProjectAssetsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchAssociateProjectAssetsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchAssociateProjectAssetsOutput struct { // A list of associated error information, if any. Errors []*AssetErrorDetails `locationName:"errors" type:"list"` // contains filtered or unexported fields }
func (s BatchAssociateProjectAssetsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchAssociateProjectAssetsOutput) SetErrors(v []*AssetErrorDetails) *BatchAssociateProjectAssetsOutput
SetErrors sets the Errors field's value.
func (s BatchAssociateProjectAssetsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchDisassociateProjectAssetsInput struct { // The IDs of the assets to be disassociated from the project. // // AssetIds is a required field AssetIds []*string `locationName:"assetIds" min:"1" type:"list" required:"true"` // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // The ID of the project from which to disassociate the assets. // // ProjectId is a required field ProjectId *string `location:"uri" locationName:"projectId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s BatchDisassociateProjectAssetsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDisassociateProjectAssetsInput) SetAssetIds(v []*string) *BatchDisassociateProjectAssetsInput
SetAssetIds sets the AssetIds field's value.
func (s *BatchDisassociateProjectAssetsInput) SetClientToken(v string) *BatchDisassociateProjectAssetsInput
SetClientToken sets the ClientToken field's value.
func (s *BatchDisassociateProjectAssetsInput) SetProjectId(v string) *BatchDisassociateProjectAssetsInput
SetProjectId sets the ProjectId field's value.
func (s BatchDisassociateProjectAssetsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDisassociateProjectAssetsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchDisassociateProjectAssetsOutput struct { // A list of associated error information, if any. Errors []*AssetErrorDetails `locationName:"errors" type:"list"` // contains filtered or unexported fields }
func (s BatchDisassociateProjectAssetsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchDisassociateProjectAssetsOutput) SetErrors(v []*AssetErrorDetails) *BatchDisassociateProjectAssetsOutput
SetErrors sets the Errors field's value.
func (s BatchDisassociateProjectAssetsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchGetAssetPropertyAggregatesEntry struct { // The data aggregating function. // // AggregateTypes is a required field AggregateTypes []*string `locationName:"aggregateTypes" min:"1" type:"list" required:"true" enum:"AggregateType"` // The ID of the asset in which the asset property was created. AssetId *string `locationName:"assetId" min:"36" type:"string"` // The inclusive end of the range from which to query historical data, expressed // in seconds in Unix epoch time. // // EndDate is a required field EndDate *time.Time `locationName:"endDate" type:"timestamp" required:"true"` // The ID of the entry. // // EntryId is a required field EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"` // 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. PropertyAlias *string `locationName:"propertyAlias" min:"1" type:"string"` // The ID of the asset property. PropertyId *string `locationName:"propertyId" min:"36" type:"string"` // The quality by which to filter asset data. Qualities []*string `locationName:"qualities" min:"1" type:"list" enum:"Quality"` // The time interval over which to aggregate data. // // Resolution is a required field Resolution *string `locationName:"resolution" min:"2" type:"string" required:"true"` // The exclusive start of the range from which to query historical data, expressed // in seconds in Unix epoch time. // // StartDate is a required field StartDate *time.Time `locationName:"startDate" type:"timestamp" required:"true"` // The chronological sorting order of the requested information. // // Default: ASCENDING TimeOrdering *string `locationName:"timeOrdering" type:"string" enum:"TimeOrdering"` // contains filtered or unexported fields }
Contains information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) API.
To identify an asset property, you must specify one of the following:
* The assetId and propertyId of an asset property. * A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html).
func (s BatchGetAssetPropertyAggregatesEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyAggregatesEntry) SetAggregateTypes(v []*string) *BatchGetAssetPropertyAggregatesEntry
SetAggregateTypes sets the AggregateTypes field's value.
func (s *BatchGetAssetPropertyAggregatesEntry) SetAssetId(v string) *BatchGetAssetPropertyAggregatesEntry
SetAssetId sets the AssetId field's value.
func (s *BatchGetAssetPropertyAggregatesEntry) SetEndDate(v time.Time) *BatchGetAssetPropertyAggregatesEntry
SetEndDate sets the EndDate field's value.
func (s *BatchGetAssetPropertyAggregatesEntry) SetEntryId(v string) *BatchGetAssetPropertyAggregatesEntry
SetEntryId sets the EntryId field's value.
func (s *BatchGetAssetPropertyAggregatesEntry) SetPropertyAlias(v string) *BatchGetAssetPropertyAggregatesEntry
SetPropertyAlias sets the PropertyAlias field's value.
func (s *BatchGetAssetPropertyAggregatesEntry) SetPropertyId(v string) *BatchGetAssetPropertyAggregatesEntry
SetPropertyId sets the PropertyId field's value.
func (s *BatchGetAssetPropertyAggregatesEntry) SetQualities(v []*string) *BatchGetAssetPropertyAggregatesEntry
SetQualities sets the Qualities field's value.
func (s *BatchGetAssetPropertyAggregatesEntry) SetResolution(v string) *BatchGetAssetPropertyAggregatesEntry
SetResolution sets the Resolution field's value.
func (s *BatchGetAssetPropertyAggregatesEntry) SetStartDate(v time.Time) *BatchGetAssetPropertyAggregatesEntry
SetStartDate sets the StartDate field's value.
func (s *BatchGetAssetPropertyAggregatesEntry) SetTimeOrdering(v string) *BatchGetAssetPropertyAggregatesEntry
SetTimeOrdering sets the TimeOrdering field's value.
func (s BatchGetAssetPropertyAggregatesEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyAggregatesEntry) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchGetAssetPropertyAggregatesErrorEntry struct { // The ID of the entry. // // EntryId is a required field EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"` // The error code. // // ErrorCode is a required field ErrorCode *string `locationName:"errorCode" type:"string" required:"true" enum:"BatchGetAssetPropertyAggregatesErrorCode"` // The associated error message. // // ErrorMessage is a required field ErrorMessage *string `locationName:"errorMessage" type:"string" required:"true"` // contains filtered or unexported fields }
Contains error information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) API.
func (s BatchGetAssetPropertyAggregatesErrorEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyAggregatesErrorEntry) SetEntryId(v string) *BatchGetAssetPropertyAggregatesErrorEntry
SetEntryId sets the EntryId field's value.
func (s *BatchGetAssetPropertyAggregatesErrorEntry) SetErrorCode(v string) *BatchGetAssetPropertyAggregatesErrorEntry
SetErrorCode sets the ErrorCode field's value.
func (s *BatchGetAssetPropertyAggregatesErrorEntry) SetErrorMessage(v string) *BatchGetAssetPropertyAggregatesErrorEntry
SetErrorMessage sets the ErrorMessage field's value.
func (s BatchGetAssetPropertyAggregatesErrorEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchGetAssetPropertyAggregatesErrorInfo struct { // The error code. // // ErrorCode is a required field ErrorCode *string `locationName:"errorCode" type:"string" required:"true" enum:"BatchGetAssetPropertyAggregatesErrorCode"` // The date the error occurred, in Unix epoch time. // // ErrorTimestamp is a required field ErrorTimestamp *time.Time `locationName:"errorTimestamp" type:"timestamp" required:"true"` // contains filtered or unexported fields }
Contains the error code and the timestamp for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) API.
func (s BatchGetAssetPropertyAggregatesErrorInfo) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyAggregatesErrorInfo) SetErrorCode(v string) *BatchGetAssetPropertyAggregatesErrorInfo
SetErrorCode sets the ErrorCode field's value.
func (s *BatchGetAssetPropertyAggregatesErrorInfo) SetErrorTimestamp(v time.Time) *BatchGetAssetPropertyAggregatesErrorInfo
SetErrorTimestamp sets the ErrorTimestamp field's value.
func (s BatchGetAssetPropertyAggregatesErrorInfo) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchGetAssetPropertyAggregatesInput struct { // The list of asset property aggregate entries for the batch get request. You // can specify up to 16 entries per request. // // Entries is a required field Entries []*BatchGetAssetPropertyAggregatesEntry `locationName:"entries" type:"list" required:"true"` // The maximum number of results to return for each paginated request. A result // set is returned in the two cases, whichever occurs first. // // * The size of the result set is less than 1 MB. // // * The number of data points in the result set is less than the value of // maxResults. The maximum value of maxResults is 4000. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` // The token to be used for the next set of paginated results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s BatchGetAssetPropertyAggregatesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyAggregatesInput) SetEntries(v []*BatchGetAssetPropertyAggregatesEntry) *BatchGetAssetPropertyAggregatesInput
SetEntries sets the Entries field's value.
func (s *BatchGetAssetPropertyAggregatesInput) SetMaxResults(v int64) *BatchGetAssetPropertyAggregatesInput
SetMaxResults sets the MaxResults field's value.
func (s *BatchGetAssetPropertyAggregatesInput) SetNextToken(v string) *BatchGetAssetPropertyAggregatesInput
SetNextToken sets the NextToken field's value.
func (s BatchGetAssetPropertyAggregatesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyAggregatesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchGetAssetPropertyAggregatesOutput struct { // A list of the errors (if any) associated with the batch request. Each error // entry contains the entryId of the entry that failed. // // ErrorEntries is a required field ErrorEntries []*BatchGetAssetPropertyAggregatesErrorEntry `locationName:"errorEntries" type:"list" required:"true"` // The token for the next set of results, or null if there are no additional // results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // A list of entries that were not processed by this batch request. because // these entries had been completely processed by previous paginated requests. // Each skipped entry contains the entryId of the entry that skipped. // // SkippedEntries is a required field SkippedEntries []*BatchGetAssetPropertyAggregatesSkippedEntry `locationName:"skippedEntries" type:"list" required:"true"` // A list of entries that were processed successfully by this batch request. // Each success entry contains the entryId of the entry that succeeded and the // latest query result. // // SuccessEntries is a required field SuccessEntries []*BatchGetAssetPropertyAggregatesSuccessEntry `locationName:"successEntries" type:"list" required:"true"` // contains filtered or unexported fields }
func (s BatchGetAssetPropertyAggregatesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyAggregatesOutput) SetErrorEntries(v []*BatchGetAssetPropertyAggregatesErrorEntry) *BatchGetAssetPropertyAggregatesOutput
SetErrorEntries sets the ErrorEntries field's value.
func (s *BatchGetAssetPropertyAggregatesOutput) SetNextToken(v string) *BatchGetAssetPropertyAggregatesOutput
SetNextToken sets the NextToken field's value.
func (s *BatchGetAssetPropertyAggregatesOutput) SetSkippedEntries(v []*BatchGetAssetPropertyAggregatesSkippedEntry) *BatchGetAssetPropertyAggregatesOutput
SetSkippedEntries sets the SkippedEntries field's value.
func (s *BatchGetAssetPropertyAggregatesOutput) SetSuccessEntries(v []*BatchGetAssetPropertyAggregatesSuccessEntry) *BatchGetAssetPropertyAggregatesOutput
SetSuccessEntries sets the SuccessEntries field's value.
func (s BatchGetAssetPropertyAggregatesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchGetAssetPropertyAggregatesSkippedEntry struct { // The completion status of each entry that is associated with the BatchGetAssetPropertyAggregates // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) // API. // // CompletionStatus is a required field CompletionStatus *string `locationName:"completionStatus" type:"string" required:"true" enum:"BatchEntryCompletionStatus"` // The ID of the entry. // // EntryId is a required field EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"` // The error information, such as the error code and the timestamp. ErrorInfo *BatchGetAssetPropertyAggregatesErrorInfo `locationName:"errorInfo" type:"structure"` // contains filtered or unexported fields }
Contains information for an entry that has been processed by the previous BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) request.
func (s BatchGetAssetPropertyAggregatesSkippedEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyAggregatesSkippedEntry) SetCompletionStatus(v string) *BatchGetAssetPropertyAggregatesSkippedEntry
SetCompletionStatus sets the CompletionStatus field's value.
func (s *BatchGetAssetPropertyAggregatesSkippedEntry) SetEntryId(v string) *BatchGetAssetPropertyAggregatesSkippedEntry
SetEntryId sets the EntryId field's value.
func (s *BatchGetAssetPropertyAggregatesSkippedEntry) SetErrorInfo(v *BatchGetAssetPropertyAggregatesErrorInfo) *BatchGetAssetPropertyAggregatesSkippedEntry
SetErrorInfo sets the ErrorInfo field's value.
func (s BatchGetAssetPropertyAggregatesSkippedEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchGetAssetPropertyAggregatesSuccessEntry struct { // The requested aggregated asset property values (for example, average, minimum, // and maximum). // // AggregatedValues is a required field AggregatedValues []*AggregatedValue `locationName:"aggregatedValues" type:"list" required:"true"` // The ID of the entry. // // EntryId is a required field EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains success information for an entry that is associated with the BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) API.
func (s BatchGetAssetPropertyAggregatesSuccessEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyAggregatesSuccessEntry) SetAggregatedValues(v []*AggregatedValue) *BatchGetAssetPropertyAggregatesSuccessEntry
SetAggregatedValues sets the AggregatedValues field's value.
func (s *BatchGetAssetPropertyAggregatesSuccessEntry) SetEntryId(v string) *BatchGetAssetPropertyAggregatesSuccessEntry
SetEntryId sets the EntryId field's value.
func (s BatchGetAssetPropertyAggregatesSuccessEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchGetAssetPropertyValueEntry struct { // The ID of the asset in which the asset property was created. AssetId *string `locationName:"assetId" min:"36" type:"string"` // The ID of the entry. // // EntryId is a required field EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"` // 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. PropertyAlias *string `locationName:"propertyAlias" min:"1" type:"string"` // The ID of the asset property. PropertyId *string `locationName:"propertyId" min:"36" type:"string"` // contains filtered or unexported fields }
Contains information for an asset property value entry that is associated with the BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) API.
To identify an asset property, you must specify one of the following:
* The assetId and propertyId of an asset property. * A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html).
func (s BatchGetAssetPropertyValueEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyValueEntry) SetAssetId(v string) *BatchGetAssetPropertyValueEntry
SetAssetId sets the AssetId field's value.
func (s *BatchGetAssetPropertyValueEntry) SetEntryId(v string) *BatchGetAssetPropertyValueEntry
SetEntryId sets the EntryId field's value.
func (s *BatchGetAssetPropertyValueEntry) SetPropertyAlias(v string) *BatchGetAssetPropertyValueEntry
SetPropertyAlias sets the PropertyAlias field's value.
func (s *BatchGetAssetPropertyValueEntry) SetPropertyId(v string) *BatchGetAssetPropertyValueEntry
SetPropertyId sets the PropertyId field's value.
func (s BatchGetAssetPropertyValueEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyValueEntry) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchGetAssetPropertyValueErrorEntry struct { // The ID of the entry. // // EntryId is a required field EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"` // The error code. // // ErrorCode is a required field ErrorCode *string `locationName:"errorCode" type:"string" required:"true" enum:"BatchGetAssetPropertyValueErrorCode"` // The associated error message. // // ErrorMessage is a required field ErrorMessage *string `locationName:"errorMessage" type:"string" required:"true"` // contains filtered or unexported fields }
Contains error information for an asset property value entry that is associated with the BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) API.
func (s BatchGetAssetPropertyValueErrorEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyValueErrorEntry) SetEntryId(v string) *BatchGetAssetPropertyValueErrorEntry
SetEntryId sets the EntryId field's value.
func (s *BatchGetAssetPropertyValueErrorEntry) SetErrorCode(v string) *BatchGetAssetPropertyValueErrorEntry
SetErrorCode sets the ErrorCode field's value.
func (s *BatchGetAssetPropertyValueErrorEntry) SetErrorMessage(v string) *BatchGetAssetPropertyValueErrorEntry
SetErrorMessage sets the ErrorMessage field's value.
func (s BatchGetAssetPropertyValueErrorEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchGetAssetPropertyValueErrorInfo struct { // The error code. // // ErrorCode is a required field ErrorCode *string `locationName:"errorCode" type:"string" required:"true" enum:"BatchGetAssetPropertyValueErrorCode"` // The date the error occurred, in Unix epoch time. // // ErrorTimestamp is a required field ErrorTimestamp *time.Time `locationName:"errorTimestamp" type:"timestamp" required:"true"` // contains filtered or unexported fields }
The error information, such as the error code and the timestamp.
func (s BatchGetAssetPropertyValueErrorInfo) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyValueErrorInfo) SetErrorCode(v string) *BatchGetAssetPropertyValueErrorInfo
SetErrorCode sets the ErrorCode field's value.
func (s *BatchGetAssetPropertyValueErrorInfo) SetErrorTimestamp(v time.Time) *BatchGetAssetPropertyValueErrorInfo
SetErrorTimestamp sets the ErrorTimestamp field's value.
func (s BatchGetAssetPropertyValueErrorInfo) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchGetAssetPropertyValueHistoryEntry struct { // The ID of the asset in which the asset property was created. AssetId *string `locationName:"assetId" min:"36" type:"string"` // The inclusive end of the range from which to query historical data, expressed // in seconds in Unix epoch time. EndDate *time.Time `locationName:"endDate" type:"timestamp"` // The ID of the entry. // // EntryId is a required field EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"` // 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. PropertyAlias *string `locationName:"propertyAlias" min:"1" type:"string"` // The ID of the asset property. PropertyId *string `locationName:"propertyId" min:"36" type:"string"` // The quality by which to filter asset data. Qualities []*string `locationName:"qualities" min:"1" type:"list" enum:"Quality"` // The exclusive start of the range from which to query historical data, expressed // in seconds in Unix epoch time. StartDate *time.Time `locationName:"startDate" type:"timestamp"` // The chronological sorting order of the requested information. // // Default: ASCENDING TimeOrdering *string `locationName:"timeOrdering" type:"string" enum:"TimeOrdering"` // contains filtered or unexported fields }
Contains information for an asset property historical value entry that is associated with the BatchGetAssetPropertyValueHistory (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) API.
To identify an asset property, you must specify one of the following:
* The assetId and propertyId of an asset property. * A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html).
func (s BatchGetAssetPropertyValueHistoryEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyValueHistoryEntry) SetAssetId(v string) *BatchGetAssetPropertyValueHistoryEntry
SetAssetId sets the AssetId field's value.
func (s *BatchGetAssetPropertyValueHistoryEntry) SetEndDate(v time.Time) *BatchGetAssetPropertyValueHistoryEntry
SetEndDate sets the EndDate field's value.
func (s *BatchGetAssetPropertyValueHistoryEntry) SetEntryId(v string) *BatchGetAssetPropertyValueHistoryEntry
SetEntryId sets the EntryId field's value.
func (s *BatchGetAssetPropertyValueHistoryEntry) SetPropertyAlias(v string) *BatchGetAssetPropertyValueHistoryEntry
SetPropertyAlias sets the PropertyAlias field's value.
func (s *BatchGetAssetPropertyValueHistoryEntry) SetPropertyId(v string) *BatchGetAssetPropertyValueHistoryEntry
SetPropertyId sets the PropertyId field's value.
func (s *BatchGetAssetPropertyValueHistoryEntry) SetQualities(v []*string) *BatchGetAssetPropertyValueHistoryEntry
SetQualities sets the Qualities field's value.
func (s *BatchGetAssetPropertyValueHistoryEntry) SetStartDate(v time.Time) *BatchGetAssetPropertyValueHistoryEntry
SetStartDate sets the StartDate field's value.
func (s *BatchGetAssetPropertyValueHistoryEntry) SetTimeOrdering(v string) *BatchGetAssetPropertyValueHistoryEntry
SetTimeOrdering sets the TimeOrdering field's value.
func (s BatchGetAssetPropertyValueHistoryEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyValueHistoryEntry) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchGetAssetPropertyValueHistoryErrorEntry struct { // The ID of the entry. // // EntryId is a required field EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"` // The error code. // // ErrorCode is a required field ErrorCode *string `locationName:"errorCode" type:"string" required:"true" enum:"BatchGetAssetPropertyValueHistoryErrorCode"` // The associated error message. // // ErrorMessage is a required field ErrorMessage *string `locationName:"errorMessage" type:"string" required:"true"` // 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.
func (s BatchGetAssetPropertyValueHistoryErrorEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyValueHistoryErrorEntry) SetEntryId(v string) *BatchGetAssetPropertyValueHistoryErrorEntry
SetEntryId sets the EntryId field's value.
func (s *BatchGetAssetPropertyValueHistoryErrorEntry) SetErrorCode(v string) *BatchGetAssetPropertyValueHistoryErrorEntry
SetErrorCode sets the ErrorCode field's value.
func (s *BatchGetAssetPropertyValueHistoryErrorEntry) SetErrorMessage(v string) *BatchGetAssetPropertyValueHistoryErrorEntry
SetErrorMessage sets the ErrorMessage field's value.
func (s BatchGetAssetPropertyValueHistoryErrorEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchGetAssetPropertyValueHistoryErrorInfo struct { // The error code. // // ErrorCode is a required field ErrorCode *string `locationName:"errorCode" type:"string" required:"true" enum:"BatchGetAssetPropertyValueHistoryErrorCode"` // The date the error occurred, in Unix epoch time. // // ErrorTimestamp is a required field ErrorTimestamp *time.Time `locationName:"errorTimestamp" type:"timestamp" required:"true"` // contains filtered or unexported fields }
The error information, such as the error code and the timestamp.
func (s BatchGetAssetPropertyValueHistoryErrorInfo) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyValueHistoryErrorInfo) SetErrorCode(v string) *BatchGetAssetPropertyValueHistoryErrorInfo
SetErrorCode sets the ErrorCode field's value.
func (s *BatchGetAssetPropertyValueHistoryErrorInfo) SetErrorTimestamp(v time.Time) *BatchGetAssetPropertyValueHistoryErrorInfo
SetErrorTimestamp sets the ErrorTimestamp field's value.
func (s BatchGetAssetPropertyValueHistoryErrorInfo) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchGetAssetPropertyValueHistoryInput struct { // The list of asset property historical value entries for the batch get request. // You can specify up to 16 entries per request. // // Entries is a required field Entries []*BatchGetAssetPropertyValueHistoryEntry `locationName:"entries" type:"list" required:"true"` // The maximum number of results to return for each paginated request. A result // set is returned in the two cases, whichever occurs first. // // * The size of the result set is less than 1 MB. // // * The number of data points in the result set is less than the value of // maxResults. The maximum value of maxResults is 4000. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` // The token to be used for the next set of paginated results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s BatchGetAssetPropertyValueHistoryInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyValueHistoryInput) SetEntries(v []*BatchGetAssetPropertyValueHistoryEntry) *BatchGetAssetPropertyValueHistoryInput
SetEntries sets the Entries field's value.
func (s *BatchGetAssetPropertyValueHistoryInput) SetMaxResults(v int64) *BatchGetAssetPropertyValueHistoryInput
SetMaxResults sets the MaxResults field's value.
func (s *BatchGetAssetPropertyValueHistoryInput) SetNextToken(v string) *BatchGetAssetPropertyValueHistoryInput
SetNextToken sets the NextToken field's value.
func (s BatchGetAssetPropertyValueHistoryInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyValueHistoryInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchGetAssetPropertyValueHistoryOutput struct { // A list of the errors (if any) associated with the batch request. Each error // entry contains the entryId of the entry that failed. // // ErrorEntries is a required field ErrorEntries []*BatchGetAssetPropertyValueHistoryErrorEntry `locationName:"errorEntries" type:"list" required:"true"` // The token for the next set of results, or null if there are no additional // results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // A list of entries that were not processed by this batch request. because // these entries had been completely processed by previous paginated requests. // Each skipped entry contains the entryId of the entry that skipped. // // SkippedEntries is a required field SkippedEntries []*BatchGetAssetPropertyValueHistorySkippedEntry `locationName:"skippedEntries" type:"list" required:"true"` // A list of entries that were processed successfully by this batch request. // Each success entry contains the entryId of the entry that succeeded and the // latest query result. // // SuccessEntries is a required field SuccessEntries []*BatchGetAssetPropertyValueHistorySuccessEntry `locationName:"successEntries" type:"list" required:"true"` // contains filtered or unexported fields }
func (s BatchGetAssetPropertyValueHistoryOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyValueHistoryOutput) SetErrorEntries(v []*BatchGetAssetPropertyValueHistoryErrorEntry) *BatchGetAssetPropertyValueHistoryOutput
SetErrorEntries sets the ErrorEntries field's value.
func (s *BatchGetAssetPropertyValueHistoryOutput) SetNextToken(v string) *BatchGetAssetPropertyValueHistoryOutput
SetNextToken sets the NextToken field's value.
func (s *BatchGetAssetPropertyValueHistoryOutput) SetSkippedEntries(v []*BatchGetAssetPropertyValueHistorySkippedEntry) *BatchGetAssetPropertyValueHistoryOutput
SetSkippedEntries sets the SkippedEntries field's value.
func (s *BatchGetAssetPropertyValueHistoryOutput) SetSuccessEntries(v []*BatchGetAssetPropertyValueHistorySuccessEntry) *BatchGetAssetPropertyValueHistoryOutput
SetSuccessEntries sets the SuccessEntries field's value.
func (s BatchGetAssetPropertyValueHistoryOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchGetAssetPropertyValueHistorySkippedEntry struct { // The completion status of each entry that is associated with the BatchGetAssetPropertyValueHistory // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValueHistory.html) // API. // // CompletionStatus is a required field CompletionStatus *string `locationName:"completionStatus" type:"string" required:"true" enum:"BatchEntryCompletionStatus"` // The ID of the entry. // // EntryId is a required field EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"` // The error information, such as the error code and the timestamp. ErrorInfo *BatchGetAssetPropertyValueHistoryErrorInfo `locationName:"errorInfo" type:"structure"` // contains filtered or unexported fields }
Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValueHistory (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) request.
func (s BatchGetAssetPropertyValueHistorySkippedEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyValueHistorySkippedEntry) SetCompletionStatus(v string) *BatchGetAssetPropertyValueHistorySkippedEntry
SetCompletionStatus sets the CompletionStatus field's value.
func (s *BatchGetAssetPropertyValueHistorySkippedEntry) SetEntryId(v string) *BatchGetAssetPropertyValueHistorySkippedEntry
SetEntryId sets the EntryId field's value.
func (s *BatchGetAssetPropertyValueHistorySkippedEntry) SetErrorInfo(v *BatchGetAssetPropertyValueHistoryErrorInfo) *BatchGetAssetPropertyValueHistorySkippedEntry
SetErrorInfo sets the ErrorInfo field's value.
func (s BatchGetAssetPropertyValueHistorySkippedEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchGetAssetPropertyValueHistorySuccessEntry struct { // The requested historical values for the specified asset property. // // AssetPropertyValueHistory is a required field AssetPropertyValueHistory []*AssetPropertyValue `locationName:"assetPropertyValueHistory" type:"list" required:"true"` // The ID of the entry. // // EntryId is a required field EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains success information for an entry that is associated with the BatchGetAssetPropertyValueHistory (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) API.
func (s BatchGetAssetPropertyValueHistorySuccessEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyValueHistorySuccessEntry) SetAssetPropertyValueHistory(v []*AssetPropertyValue) *BatchGetAssetPropertyValueHistorySuccessEntry
SetAssetPropertyValueHistory sets the AssetPropertyValueHistory field's value.
func (s *BatchGetAssetPropertyValueHistorySuccessEntry) SetEntryId(v string) *BatchGetAssetPropertyValueHistorySuccessEntry
SetEntryId sets the EntryId field's value.
func (s BatchGetAssetPropertyValueHistorySuccessEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchGetAssetPropertyValueInput struct { // The list of asset property value entries for the batch get request. You can // specify up to 16 entries per request. // // Entries is a required field Entries []*BatchGetAssetPropertyValueEntry `locationName:"entries" type:"list" required:"true"` // The token to be used for the next set of paginated results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s BatchGetAssetPropertyValueInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyValueInput) SetEntries(v []*BatchGetAssetPropertyValueEntry) *BatchGetAssetPropertyValueInput
SetEntries sets the Entries field's value.
func (s *BatchGetAssetPropertyValueInput) SetNextToken(v string) *BatchGetAssetPropertyValueInput
SetNextToken sets the NextToken field's value.
func (s BatchGetAssetPropertyValueInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyValueInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchGetAssetPropertyValueOutput struct { // A list of the errors (if any) associated with the batch request. Each error // entry contains the entryId of the entry that failed. // // ErrorEntries is a required field ErrorEntries []*BatchGetAssetPropertyValueErrorEntry `locationName:"errorEntries" type:"list" required:"true"` // The token for the next set of results, or null if there are no additional // results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // A list of entries that were not processed by this batch request. because // these entries had been completely processed by previous paginated requests. // Each skipped entry contains the entryId of the entry that skipped. // // SkippedEntries is a required field SkippedEntries []*BatchGetAssetPropertyValueSkippedEntry `locationName:"skippedEntries" type:"list" required:"true"` // A list of entries that were processed successfully by this batch request. // Each success entry contains the entryId of the entry that succeeded and the // latest query result. // // SuccessEntries is a required field SuccessEntries []*BatchGetAssetPropertyValueSuccessEntry `locationName:"successEntries" type:"list" required:"true"` // contains filtered or unexported fields }
func (s BatchGetAssetPropertyValueOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyValueOutput) SetErrorEntries(v []*BatchGetAssetPropertyValueErrorEntry) *BatchGetAssetPropertyValueOutput
SetErrorEntries sets the ErrorEntries field's value.
func (s *BatchGetAssetPropertyValueOutput) SetNextToken(v string) *BatchGetAssetPropertyValueOutput
SetNextToken sets the NextToken field's value.
func (s *BatchGetAssetPropertyValueOutput) SetSkippedEntries(v []*BatchGetAssetPropertyValueSkippedEntry) *BatchGetAssetPropertyValueOutput
SetSkippedEntries sets the SkippedEntries field's value.
func (s *BatchGetAssetPropertyValueOutput) SetSuccessEntries(v []*BatchGetAssetPropertyValueSuccessEntry) *BatchGetAssetPropertyValueOutput
SetSuccessEntries sets the SuccessEntries field's value.
func (s BatchGetAssetPropertyValueOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchGetAssetPropertyValueSkippedEntry struct { // The completion status of each entry that is associated with the BatchGetAssetPropertyValue // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) // request. // // CompletionStatus is a required field CompletionStatus *string `locationName:"completionStatus" type:"string" required:"true" enum:"BatchEntryCompletionStatus"` // The ID of the entry. // // EntryId is a required field EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"` // The error information, such as the error code and the timestamp. ErrorInfo *BatchGetAssetPropertyValueErrorInfo `locationName:"errorInfo" type:"structure"` // contains filtered or unexported fields }
Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) request.
func (s BatchGetAssetPropertyValueSkippedEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyValueSkippedEntry) SetCompletionStatus(v string) *BatchGetAssetPropertyValueSkippedEntry
SetCompletionStatus sets the CompletionStatus field's value.
func (s *BatchGetAssetPropertyValueSkippedEntry) SetEntryId(v string) *BatchGetAssetPropertyValueSkippedEntry
SetEntryId sets the EntryId field's value.
func (s *BatchGetAssetPropertyValueSkippedEntry) SetErrorInfo(v *BatchGetAssetPropertyValueErrorInfo) *BatchGetAssetPropertyValueSkippedEntry
SetErrorInfo sets the ErrorInfo field's value.
func (s BatchGetAssetPropertyValueSkippedEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchGetAssetPropertyValueSuccessEntry struct { // Contains asset property value information. AssetPropertyValue *AssetPropertyValue `locationName:"assetPropertyValue" type:"structure"` // The ID of the entry. // // EntryId is a required field EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains success information for an entry that is associated with the BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) API.
func (s BatchGetAssetPropertyValueSuccessEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchGetAssetPropertyValueSuccessEntry) SetAssetPropertyValue(v *AssetPropertyValue) *BatchGetAssetPropertyValueSuccessEntry
SetAssetPropertyValue sets the AssetPropertyValue field's value.
func (s *BatchGetAssetPropertyValueSuccessEntry) SetEntryId(v string) *BatchGetAssetPropertyValueSuccessEntry
SetEntryId sets the EntryId field's value.
func (s BatchGetAssetPropertyValueSuccessEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchPutAssetPropertyError struct { // The error code. // // ErrorCode is a required field ErrorCode *string `locationName:"errorCode" type:"string" required:"true" enum:"BatchPutAssetPropertyValueErrorCode"` // The associated error message. // // ErrorMessage is a required field ErrorMessage *string `locationName:"errorMessage" type:"string" required:"true"` // A list of timestamps for each error, if any. // // Timestamps is a required field Timestamps []*TimeInNanos `locationName:"timestamps" type:"list" required:"true"` // contains filtered or unexported fields }
Contains error information from updating a batch of asset property values.
func (s BatchPutAssetPropertyError) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchPutAssetPropertyError) SetErrorCode(v string) *BatchPutAssetPropertyError
SetErrorCode sets the ErrorCode field's value.
func (s *BatchPutAssetPropertyError) SetErrorMessage(v string) *BatchPutAssetPropertyError
SetErrorMessage sets the ErrorMessage field's value.
func (s *BatchPutAssetPropertyError) SetTimestamps(v []*TimeInNanos) *BatchPutAssetPropertyError
SetTimestamps sets the Timestamps field's value.
func (s BatchPutAssetPropertyError) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchPutAssetPropertyErrorEntry struct { // The ID of the failed entry. // // EntryId is a required field EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"` // The list of update property value errors. // // Errors is a required field Errors []*BatchPutAssetPropertyError `locationName:"errors" type:"list" required:"true"` // contains filtered or unexported fields }
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.
func (s BatchPutAssetPropertyErrorEntry) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchPutAssetPropertyErrorEntry) SetEntryId(v string) *BatchPutAssetPropertyErrorEntry
SetEntryId sets the EntryId field's value.
func (s *BatchPutAssetPropertyErrorEntry) SetErrors(v []*BatchPutAssetPropertyError) *BatchPutAssetPropertyErrorEntry
SetErrors sets the Errors field's value.
func (s BatchPutAssetPropertyErrorEntry) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BatchPutAssetPropertyValueInput struct { // The list of asset property value entries for the batch put request. You can // specify up to 10 entries per request. // // Entries is a required field Entries []*PutAssetPropertyValueEntry `locationName:"entries" type:"list" required:"true"` // contains filtered or unexported fields }
func (s BatchPutAssetPropertyValueInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchPutAssetPropertyValueInput) SetEntries(v []*PutAssetPropertyValueEntry) *BatchPutAssetPropertyValueInput
SetEntries sets the Entries field's value.
func (s BatchPutAssetPropertyValueInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchPutAssetPropertyValueInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type BatchPutAssetPropertyValueOutput struct { // A list of the errors (if any) associated with the batch put request. Each // error entry contains the entryId of the entry that failed. // // ErrorEntries is a required field ErrorEntries []*BatchPutAssetPropertyErrorEntry `locationName:"errorEntries" type:"list" required:"true"` // contains filtered or unexported fields }
func (s BatchPutAssetPropertyValueOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BatchPutAssetPropertyValueOutput) SetErrorEntries(v []*BatchPutAssetPropertyErrorEntry) *BatchPutAssetPropertyValueOutput
SetErrorEntries sets the ErrorEntries field's value.
func (s BatchPutAssetPropertyValueOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CompositeModelProperty struct { // Contains asset property information. // // AssetProperty is a required field AssetProperty *Property `locationName:"assetProperty" type:"structure" required:"true"` // The name of the property. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The type of the composite model that defines this property. // // Type is a required field Type *string `locationName:"type" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains information about a composite model property on an asset.
func (s CompositeModelProperty) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CompositeModelProperty) SetAssetProperty(v *Property) *CompositeModelProperty
SetAssetProperty sets the AssetProperty field's value.
func (s *CompositeModelProperty) SetName(v string) *CompositeModelProperty
SetName sets the Name field's value.
func (s *CompositeModelProperty) SetType(v string) *CompositeModelProperty
SetType sets the Type field's value.
func (s CompositeModelProperty) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ConfigurationErrorDetails struct { // The error code. // // Code is a required field Code *string `locationName:"code" type:"string" required:"true" enum:"ErrorCode"` // The error message. // // Message is a required field Message *string `locationName:"message" type:"string" required:"true"` // contains filtered or unexported fields }
Contains the details of an IoT SiteWise configuration error.
func (s ConfigurationErrorDetails) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ConfigurationErrorDetails) SetCode(v string) *ConfigurationErrorDetails
SetCode sets the Code field's value.
func (s *ConfigurationErrorDetails) SetMessage(v string) *ConfigurationErrorDetails
SetMessage sets the Message field's value.
func (s ConfigurationErrorDetails) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ConfigurationStatus struct { // Contains associated error information, if any. Error *ConfigurationErrorDetails `locationName:"error" type:"structure"` // The current state of the configuration. // // State is a required field State *string `locationName:"state" type:"string" required:"true" enum:"ConfigurationState"` // contains filtered or unexported fields }
Contains current status information for the configuration.
func (s ConfigurationStatus) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ConfigurationStatus) SetError(v *ConfigurationErrorDetails) *ConfigurationStatus
SetError sets the Error field's value.
func (s *ConfigurationStatus) SetState(v string) *ConfigurationStatus
SetState sets the State field's value.
func (s ConfigurationStatus) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ConflictingOperationException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // The ARN of the resource that conflicts with this operation. // // ResourceArn is a required field ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"` // The ID of the resource that conflicts with this operation. // // ResourceId is a required field ResourceId *string `locationName:"resourceId" type:"string" required:"true"` // 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 (s *ConflictingOperationException) Code() string
Code returns the exception type name.
func (s *ConflictingOperationException) Error() string
func (s ConflictingOperationException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ConflictingOperationException) Message() string
Message returns the exception's message.
func (s *ConflictingOperationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConflictingOperationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConflictingOperationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ConflictingOperationException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateAccessPolicyInput struct { // The identity for this access policy. Choose an Amazon Web Services SSO user, // an Amazon Web Services SSO group, or an IAM user. // // AccessPolicyIdentity is a required field AccessPolicyIdentity *Identity `locationName:"accessPolicyIdentity" type:"structure" required:"true"` // The permission level for this access policy. Note that a project ADMINISTRATOR // is also known as a project owner. // // AccessPolicyPermission is a required field AccessPolicyPermission *string `locationName:"accessPolicyPermission" type:"string" required:"true" enum:"Permission"` // The IoT SiteWise Monitor resource for this access policy. Choose either a // portal or a project. // // AccessPolicyResource is a required field AccessPolicyResource *Resource `locationName:"accessPolicyResource" type:"structure" required:"true"` // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // A list of key-value pairs that contain metadata for the access policy. For // more information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the IoT SiteWise User Guide. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
func (s CreateAccessPolicyInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateAccessPolicyInput) SetAccessPolicyIdentity(v *Identity) *CreateAccessPolicyInput
SetAccessPolicyIdentity sets the AccessPolicyIdentity field's value.
func (s *CreateAccessPolicyInput) SetAccessPolicyPermission(v string) *CreateAccessPolicyInput
SetAccessPolicyPermission sets the AccessPolicyPermission field's value.
func (s *CreateAccessPolicyInput) SetAccessPolicyResource(v *Resource) *CreateAccessPolicyInput
SetAccessPolicyResource sets the AccessPolicyResource field's value.
func (s *CreateAccessPolicyInput) SetClientToken(v string) *CreateAccessPolicyInput
SetClientToken sets the ClientToken field's value.
func (s *CreateAccessPolicyInput) SetTags(v map[string]*string) *CreateAccessPolicyInput
SetTags sets the Tags field's value.
func (s CreateAccessPolicyInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateAccessPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateAccessPolicyOutput struct { // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of the access policy, which has the following format. // // arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId} // // AccessPolicyArn is a required field AccessPolicyArn *string `locationName:"accessPolicyArn" min:"1" type:"string" required:"true"` // The ID of the access policy. // // AccessPolicyId is a required field AccessPolicyId *string `locationName:"accessPolicyId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s CreateAccessPolicyOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateAccessPolicyOutput) SetAccessPolicyArn(v string) *CreateAccessPolicyOutput
SetAccessPolicyArn sets the AccessPolicyArn field's value.
func (s *CreateAccessPolicyOutput) SetAccessPolicyId(v string) *CreateAccessPolicyOutput
SetAccessPolicyId sets the AccessPolicyId field's value.
func (s CreateAccessPolicyOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateAssetInput struct { // The ID of the asset model from which to create the asset. // // AssetModelId is a required field AssetModelId *string `locationName:"assetModelId" min:"36" type:"string" required:"true"` // A unique, friendly name for the asset. // // AssetName is a required field AssetName *string `locationName:"assetName" min:"1" type:"string" required:"true"` // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // A list of key-value pairs that contain metadata for the asset. For more information, // see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the IoT SiteWise User Guide. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
func (s CreateAssetInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateAssetInput) SetAssetModelId(v string) *CreateAssetInput
SetAssetModelId sets the AssetModelId field's value.
func (s *CreateAssetInput) SetAssetName(v string) *CreateAssetInput
SetAssetName sets the AssetName field's value.
func (s *CreateAssetInput) SetClientToken(v string) *CreateAssetInput
SetClientToken sets the ClientToken field's value.
func (s *CreateAssetInput) SetTags(v map[string]*string) *CreateAssetInput
SetTags sets the Tags field's value.
func (s CreateAssetInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateAssetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateAssetModelInput struct { // The composite asset models that are part of this asset model. Composite asset // models are asset models that contain specific properties. Each composite // model has a type that defines the properties that the composite model supports. // Use composite asset models to define alarms on this asset model. AssetModelCompositeModels []*AssetModelCompositeModelDefinition `locationName:"assetModelCompositeModels" type:"list"` // A description for the asset model. AssetModelDescription *string `locationName:"assetModelDescription" min:"1" type:"string"` // The hierarchy definitions of the asset model. Each hierarchy specifies an // asset model whose assets can be children of any other assets created from // this asset model. For more information, see Asset hierarchies (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) // in the IoT SiteWise User Guide. // // You can specify up to 10 hierarchies per asset model. For more information, // see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) // in the IoT SiteWise User Guide. AssetModelHierarchies []*AssetModelHierarchyDefinition `locationName:"assetModelHierarchies" type:"list"` // A unique, friendly name for the asset model. // // AssetModelName is a required field AssetModelName *string `locationName:"assetModelName" min:"1" type:"string" required:"true"` // The property definitions of the asset model. For more information, see Asset // properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html) // in the IoT SiteWise User Guide. // // You can specify up to 200 properties per asset model. For more information, // see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) // in the IoT SiteWise User Guide. AssetModelProperties []*AssetModelPropertyDefinition `locationName:"assetModelProperties" type:"list"` // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // A list of key-value pairs that contain metadata for the asset model. For // more information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the IoT SiteWise User Guide. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
func (s CreateAssetModelInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateAssetModelInput) SetAssetModelCompositeModels(v []*AssetModelCompositeModelDefinition) *CreateAssetModelInput
SetAssetModelCompositeModels sets the AssetModelCompositeModels field's value.
func (s *CreateAssetModelInput) SetAssetModelDescription(v string) *CreateAssetModelInput
SetAssetModelDescription sets the AssetModelDescription field's value.
func (s *CreateAssetModelInput) SetAssetModelHierarchies(v []*AssetModelHierarchyDefinition) *CreateAssetModelInput
SetAssetModelHierarchies sets the AssetModelHierarchies field's value.
func (s *CreateAssetModelInput) SetAssetModelName(v string) *CreateAssetModelInput
SetAssetModelName sets the AssetModelName field's value.
func (s *CreateAssetModelInput) SetAssetModelProperties(v []*AssetModelPropertyDefinition) *CreateAssetModelInput
SetAssetModelProperties sets the AssetModelProperties field's value.
func (s *CreateAssetModelInput) SetClientToken(v string) *CreateAssetModelInput
SetClientToken sets the ClientToken field's value.
func (s *CreateAssetModelInput) SetTags(v map[string]*string) *CreateAssetModelInput
SetTags sets the Tags field's value.
func (s CreateAssetModelInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateAssetModelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateAssetModelOutput 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} // // AssetModelArn is a required field AssetModelArn *string `locationName:"assetModelArn" min:"1" type:"string" required:"true"` // The ID of the asset model. You can use this ID when you call other IoT SiteWise // APIs. // // AssetModelId is a required field AssetModelId *string `locationName:"assetModelId" min:"36" type:"string" required:"true"` // The status of the asset model, which contains a state (CREATING after successfully // calling this operation) and any error message. // // AssetModelStatus is a required field AssetModelStatus *AssetModelStatus `locationName:"assetModelStatus" type:"structure" required:"true"` // contains filtered or unexported fields }
func (s CreateAssetModelOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateAssetModelOutput) SetAssetModelArn(v string) *CreateAssetModelOutput
SetAssetModelArn sets the AssetModelArn field's value.
func (s *CreateAssetModelOutput) SetAssetModelId(v string) *CreateAssetModelOutput
SetAssetModelId sets the AssetModelId field's value.
func (s *CreateAssetModelOutput) SetAssetModelStatus(v *AssetModelStatus) *CreateAssetModelOutput
SetAssetModelStatus sets the AssetModelStatus field's value.
func (s CreateAssetModelOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateAssetOutput 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} // // AssetArn is a required field AssetArn *string `locationName:"assetArn" min:"1" type:"string" required:"true"` // The ID of the asset. This ID uniquely identifies the asset within IoT SiteWise // and can be used with other IoT SiteWise APIs. // // AssetId is a required field AssetId *string `locationName:"assetId" min:"36" type:"string" required:"true"` // The status of the asset, which contains a state (CREATING after successfully // calling this operation) and any error message. // // AssetStatus is a required field AssetStatus *AssetStatus `locationName:"assetStatus" type:"structure" required:"true"` // contains filtered or unexported fields }
func (s CreateAssetOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateAssetOutput) SetAssetArn(v string) *CreateAssetOutput
SetAssetArn sets the AssetArn field's value.
func (s *CreateAssetOutput) SetAssetId(v string) *CreateAssetOutput
SetAssetId sets the AssetId field's value.
func (s *CreateAssetOutput) SetAssetStatus(v *AssetStatus) *CreateAssetOutput
SetAssetStatus sets the AssetStatus field's value.
func (s CreateAssetOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateDashboardInput struct { // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // The dashboard definition specified in a JSON literal. For detailed information, // see Creating dashboards (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) // in the IoT SiteWise User Guide. // // DashboardDefinition is a required field DashboardDefinition *string `locationName:"dashboardDefinition" type:"string" required:"true"` // A description for the dashboard. DashboardDescription *string `locationName:"dashboardDescription" min:"1" type:"string"` // A friendly name for the dashboard. // // DashboardName is a required field DashboardName *string `locationName:"dashboardName" min:"1" type:"string" required:"true"` // The ID of the project in which to create the dashboard. // // ProjectId is a required field ProjectId *string `locationName:"projectId" min:"36" type:"string" required:"true"` // A list of key-value pairs that contain metadata for the dashboard. For more // information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the IoT SiteWise User Guide. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
func (s CreateDashboardInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateDashboardInput) SetClientToken(v string) *CreateDashboardInput
SetClientToken sets the ClientToken field's value.
func (s *CreateDashboardInput) SetDashboardDefinition(v string) *CreateDashboardInput
SetDashboardDefinition sets the DashboardDefinition field's value.
func (s *CreateDashboardInput) SetDashboardDescription(v string) *CreateDashboardInput
SetDashboardDescription sets the DashboardDescription field's value.
func (s *CreateDashboardInput) SetDashboardName(v string) *CreateDashboardInput
SetDashboardName sets the DashboardName field's value.
func (s *CreateDashboardInput) SetProjectId(v string) *CreateDashboardInput
SetProjectId sets the ProjectId field's value.
func (s *CreateDashboardInput) SetTags(v map[string]*string) *CreateDashboardInput
SetTags sets the Tags field's value.
func (s CreateDashboardInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateDashboardInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateDashboardOutput struct { // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of the dashboard, which has the following format. // // arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId} // // DashboardArn is a required field DashboardArn *string `locationName:"dashboardArn" min:"1" type:"string" required:"true"` // The ID of the dashboard. // // DashboardId is a required field DashboardId *string `locationName:"dashboardId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s CreateDashboardOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateDashboardOutput) SetDashboardArn(v string) *CreateDashboardOutput
SetDashboardArn sets the DashboardArn field's value.
func (s *CreateDashboardOutput) SetDashboardId(v string) *CreateDashboardOutput
SetDashboardId sets the DashboardId field's value.
func (s CreateDashboardOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateGatewayInput struct { // A unique, friendly name for the gateway. // // GatewayName is a required field GatewayName *string `locationName:"gatewayName" min:"1" type:"string" required:"true"` // The gateway's platform. You can only specify one platform in a gateway. // // GatewayPlatform is a required field GatewayPlatform *GatewayPlatform `locationName:"gatewayPlatform" type:"structure" required:"true"` // A list of key-value pairs that contain metadata for the gateway. For more // information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the IoT SiteWise User Guide. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
func (s CreateGatewayInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateGatewayInput) SetGatewayName(v string) *CreateGatewayInput
SetGatewayName sets the GatewayName field's value.
func (s *CreateGatewayInput) SetGatewayPlatform(v *GatewayPlatform) *CreateGatewayInput
SetGatewayPlatform sets the GatewayPlatform field's value.
func (s *CreateGatewayInput) SetTags(v map[string]*string) *CreateGatewayInput
SetTags sets the Tags field's value.
func (s CreateGatewayInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateGatewayInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateGatewayOutput struct { // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of the gateway, which has the following format. // // arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId} // // GatewayArn is a required field GatewayArn *string `locationName:"gatewayArn" min:"1" type:"string" required:"true"` // The ID of the gateway device. You can use this ID when you call other IoT // SiteWise APIs. // // GatewayId is a required field GatewayId *string `locationName:"gatewayId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s CreateGatewayOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateGatewayOutput) SetGatewayArn(v string) *CreateGatewayOutput
SetGatewayArn sets the GatewayArn field's value.
func (s *CreateGatewayOutput) SetGatewayId(v string) *CreateGatewayOutput
SetGatewayId sets the GatewayId field's value.
func (s CreateGatewayOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreatePortalInput struct { // 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 alarms (https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) // in the IoT SiteWise Application Guide. Alarms *Alarms `locationName:"alarms" type:"structure"` // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // The email address that sends alarm notifications. // // If you use the IoT Events managed Lambda function (https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) // to manage your emails, you must verify the sender email address in Amazon // SES (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html). NotificationSenderEmail *string `locationName:"notificationSenderEmail" min:"1" type:"string"` // The service to use to authenticate users to the portal. Choose from the following // options: // // * SSO – The portal uses Amazon Web Services Single Sign On to authenticate // users and manage user permissions. Before you can create a portal that // uses Amazon Web Services SSO, you must enable Amazon Web Services SSO. // For more information, see Enabling Amazon Web Services SSO (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso) // in the IoT SiteWise User Guide. This option is only available in Amazon // Web Services Regions other than the China Regions. // // * IAM – The portal uses Identity and Access Management to authenticate // users and manage user permissions. // // You can't change this value after you create a portal. // // Default: SSO PortalAuthMode *string `locationName:"portalAuthMode" type:"string" enum:"AuthMode"` // The Amazon Web Services administrator's contact email address. // // PortalContactEmail is a required field PortalContactEmail *string `locationName:"portalContactEmail" min:"1" type:"string" required:"true"` // A description for the portal. PortalDescription *string `locationName:"portalDescription" min:"1" type:"string"` // A logo image to display in the portal. Upload a square, high-resolution image. // The image is displayed on a dark background. PortalLogoImageFile *ImageFile `locationName:"portalLogoImageFile" type:"structure"` // A friendly name for the portal. // // PortalName is a required field PortalName *string `locationName:"portalName" min:"1" type:"string" required:"true"` // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of a 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) // in the IoT SiteWise User Guide. // // RoleArn is a required field RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"` // A list of key-value pairs that contain metadata for the portal. For more // information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the IoT SiteWise User Guide. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
func (s CreatePortalInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreatePortalInput) SetAlarms(v *Alarms) *CreatePortalInput
SetAlarms sets the Alarms field's value.
func (s *CreatePortalInput) SetClientToken(v string) *CreatePortalInput
SetClientToken sets the ClientToken field's value.
func (s *CreatePortalInput) SetNotificationSenderEmail(v string) *CreatePortalInput
SetNotificationSenderEmail sets the NotificationSenderEmail field's value.
func (s *CreatePortalInput) SetPortalAuthMode(v string) *CreatePortalInput
SetPortalAuthMode sets the PortalAuthMode field's value.
func (s *CreatePortalInput) SetPortalContactEmail(v string) *CreatePortalInput
SetPortalContactEmail sets the PortalContactEmail field's value.
func (s *CreatePortalInput) SetPortalDescription(v string) *CreatePortalInput
SetPortalDescription sets the PortalDescription field's value.
func (s *CreatePortalInput) SetPortalLogoImageFile(v *ImageFile) *CreatePortalInput
SetPortalLogoImageFile sets the PortalLogoImageFile field's value.
func (s *CreatePortalInput) SetPortalName(v string) *CreatePortalInput
SetPortalName sets the PortalName field's value.
func (s *CreatePortalInput) SetRoleArn(v string) *CreatePortalInput
SetRoleArn sets the RoleArn field's value.
func (s *CreatePortalInput) SetTags(v map[string]*string) *CreatePortalInput
SetTags sets the Tags field's value.
func (s CreatePortalInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreatePortalInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreatePortalOutput struct { // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of the portal, which has the following format. // // arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} // // PortalArn is a required field PortalArn *string `locationName:"portalArn" min:"1" type:"string" required:"true"` // The ID of the created portal. // // PortalId is a required field PortalId *string `locationName:"portalId" min:"36" type:"string" required:"true"` // The URL for the IoT SiteWise Monitor portal. You can use this URL to access // portals that use Amazon Web Services SSO 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. // // PortalStartUrl is a required field PortalStartUrl *string `locationName:"portalStartUrl" min:"1" type:"string" required:"true"` // The status of the portal, which contains a state (CREATING after successfully // calling this operation) and any error message. // // PortalStatus is a required field PortalStatus *PortalStatus `locationName:"portalStatus" type:"structure" required:"true"` // The associated Amazon Web Services SSO application ID, if the portal uses // Amazon Web Services SSO. // // SsoApplicationId is a required field SsoApplicationId *string `locationName:"ssoApplicationId" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s CreatePortalOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreatePortalOutput) SetPortalArn(v string) *CreatePortalOutput
SetPortalArn sets the PortalArn field's value.
func (s *CreatePortalOutput) SetPortalId(v string) *CreatePortalOutput
SetPortalId sets the PortalId field's value.
func (s *CreatePortalOutput) SetPortalStartUrl(v string) *CreatePortalOutput
SetPortalStartUrl sets the PortalStartUrl field's value.
func (s *CreatePortalOutput) SetPortalStatus(v *PortalStatus) *CreatePortalOutput
SetPortalStatus sets the PortalStatus field's value.
func (s *CreatePortalOutput) SetSsoApplicationId(v string) *CreatePortalOutput
SetSsoApplicationId sets the SsoApplicationId field's value.
func (s CreatePortalOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateProjectInput struct { // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // The ID of the portal in which to create the project. // // PortalId is a required field PortalId *string `locationName:"portalId" min:"36" type:"string" required:"true"` // A description for the project. ProjectDescription *string `locationName:"projectDescription" min:"1" type:"string"` // A friendly name for the project. // // ProjectName is a required field ProjectName *string `locationName:"projectName" min:"1" type:"string" required:"true"` // A list of key-value pairs that contain metadata for the project. For more // information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) // in the IoT SiteWise User Guide. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
func (s CreateProjectInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateProjectInput) SetClientToken(v string) *CreateProjectInput
SetClientToken sets the ClientToken field's value.
func (s *CreateProjectInput) SetPortalId(v string) *CreateProjectInput
SetPortalId sets the PortalId field's value.
func (s *CreateProjectInput) SetProjectDescription(v string) *CreateProjectInput
SetProjectDescription sets the ProjectDescription field's value.
func (s *CreateProjectInput) SetProjectName(v string) *CreateProjectInput
SetProjectName sets the ProjectName field's value.
func (s *CreateProjectInput) SetTags(v map[string]*string) *CreateProjectInput
SetTags sets the Tags field's value.
func (s CreateProjectInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateProjectInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateProjectOutput struct { // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of the project, which has the following format. // // arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId} // // ProjectArn is a required field ProjectArn *string `locationName:"projectArn" min:"1" type:"string" required:"true"` // The ID of the project. // // ProjectId is a required field ProjectId *string `locationName:"projectId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s CreateProjectOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateProjectOutput) SetProjectArn(v string) *CreateProjectOutput
SetProjectArn sets the ProjectArn field's value.
func (s *CreateProjectOutput) SetProjectId(v string) *CreateProjectOutput
SetProjectId sets the ProjectId field's value.
func (s CreateProjectOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CustomerManagedS3Storage struct { // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of the Identity and Access Management role that allows IoT SiteWise to send // data to Amazon S3. // // RoleArn is a required field RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"` // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of the Amazon S3 object. For more information about how to find the ARN for // an Amazon S3 object, see Amazon S3 resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-arn-format.html) // in the Amazon Simple Storage Service User Guide. // // S3ResourceArn is a required field S3ResourceArn *string `locationName:"s3ResourceArn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains information about a customer managed Amazon S3 bucket.
func (s CustomerManagedS3Storage) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CustomerManagedS3Storage) SetRoleArn(v string) *CustomerManagedS3Storage
SetRoleArn sets the RoleArn field's value.
func (s *CustomerManagedS3Storage) SetS3ResourceArn(v string) *CustomerManagedS3Storage
SetS3ResourceArn sets the S3ResourceArn field's value.
func (s CustomerManagedS3Storage) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CustomerManagedS3Storage) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DashboardSummary struct { // The date the dashboard was created, in Unix epoch time. CreationDate *time.Time `locationName:"creationDate" type:"timestamp"` // The dashboard's description. Description *string `locationName:"description" min:"1" type:"string"` // The ID of the dashboard. // // Id is a required field Id *string `locationName:"id" min:"36" type:"string" required:"true"` // The date the dashboard was last updated, in Unix epoch time. LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp"` // The name of the dashboard // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains a dashboard summary.
func (s DashboardSummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DashboardSummary) SetCreationDate(v time.Time) *DashboardSummary
SetCreationDate sets the CreationDate field's value.
func (s *DashboardSummary) SetDescription(v string) *DashboardSummary
SetDescription sets the Description field's value.
func (s *DashboardSummary) SetId(v string) *DashboardSummary
SetId sets the Id field's value.
func (s *DashboardSummary) SetLastUpdateDate(v time.Time) *DashboardSummary
SetLastUpdateDate sets the LastUpdateDate field's value.
func (s *DashboardSummary) SetName(v string) *DashboardSummary
SetName sets the Name field's value.
func (s DashboardSummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteAccessPolicyInput struct { // The ID of the access policy to be deleted. // // AccessPolicyId is a required field AccessPolicyId *string `location:"uri" locationName:"accessPolicyId" min:"36" type:"string" required:"true"` // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `location:"querystring" locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // contains filtered or unexported fields }
func (s DeleteAccessPolicyInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteAccessPolicyInput) SetAccessPolicyId(v string) *DeleteAccessPolicyInput
SetAccessPolicyId sets the AccessPolicyId field's value.
func (s *DeleteAccessPolicyInput) SetClientToken(v string) *DeleteAccessPolicyInput
SetClientToken sets the ClientToken field's value.
func (s DeleteAccessPolicyInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteAccessPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteAccessPolicyOutput struct {
// contains filtered or unexported fields
}
func (s DeleteAccessPolicyOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteAccessPolicyOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteAssetInput struct { // The ID of the asset to delete. // // AssetId is a required field AssetId *string `location:"uri" locationName:"assetId" min:"36" type:"string" required:"true"` // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `location:"querystring" locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // contains filtered or unexported fields }
func (s DeleteAssetInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteAssetInput) SetAssetId(v string) *DeleteAssetInput
SetAssetId sets the AssetId field's value.
func (s *DeleteAssetInput) SetClientToken(v string) *DeleteAssetInput
SetClientToken sets the ClientToken field's value.
func (s DeleteAssetInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteAssetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteAssetModelInput struct { // The ID of the asset model to delete. // // AssetModelId is a required field AssetModelId *string `location:"uri" locationName:"assetModelId" min:"36" type:"string" required:"true"` // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `location:"querystring" locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // contains filtered or unexported fields }
func (s DeleteAssetModelInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteAssetModelInput) SetAssetModelId(v string) *DeleteAssetModelInput
SetAssetModelId sets the AssetModelId field's value.
func (s *DeleteAssetModelInput) SetClientToken(v string) *DeleteAssetModelInput
SetClientToken sets the ClientToken field's value.
func (s DeleteAssetModelInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteAssetModelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteAssetModelOutput struct { // The status of the asset model, which contains a state (DELETING after successfully // calling this operation) and any error message. // // AssetModelStatus is a required field AssetModelStatus *AssetModelStatus `locationName:"assetModelStatus" type:"structure" required:"true"` // contains filtered or unexported fields }
func (s DeleteAssetModelOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteAssetModelOutput) SetAssetModelStatus(v *AssetModelStatus) *DeleteAssetModelOutput
SetAssetModelStatus sets the AssetModelStatus field's value.
func (s DeleteAssetModelOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteAssetOutput struct { // The status of the asset, which contains a state (DELETING after successfully // calling this operation) and any error message. // // AssetStatus is a required field AssetStatus *AssetStatus `locationName:"assetStatus" type:"structure" required:"true"` // contains filtered or unexported fields }
func (s DeleteAssetOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteAssetOutput) SetAssetStatus(v *AssetStatus) *DeleteAssetOutput
SetAssetStatus sets the AssetStatus field's value.
func (s DeleteAssetOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteDashboardInput struct { // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `location:"querystring" locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // The ID of the dashboard to delete. // // DashboardId is a required field DashboardId *string `location:"uri" locationName:"dashboardId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteDashboardInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteDashboardInput) SetClientToken(v string) *DeleteDashboardInput
SetClientToken sets the ClientToken field's value.
func (s *DeleteDashboardInput) SetDashboardId(v string) *DeleteDashboardInput
SetDashboardId sets the DashboardId field's value.
func (s DeleteDashboardInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteDashboardInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteDashboardOutput struct {
// contains filtered or unexported fields
}
func (s DeleteDashboardOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteDashboardOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteGatewayInput struct { // The ID of the gateway to delete. // // GatewayId is a required field GatewayId *string `location:"uri" locationName:"gatewayId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteGatewayInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteGatewayInput) SetGatewayId(v string) *DeleteGatewayInput
SetGatewayId sets the GatewayId field's value.
func (s DeleteGatewayInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteGatewayInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteGatewayOutput struct {
// contains filtered or unexported fields
}
func (s DeleteGatewayOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteGatewayOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeletePortalInput struct { // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `location:"querystring" locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // The ID of the portal to delete. // // PortalId is a required field PortalId *string `location:"uri" locationName:"portalId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeletePortalInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeletePortalInput) SetClientToken(v string) *DeletePortalInput
SetClientToken sets the ClientToken field's value.
func (s *DeletePortalInput) SetPortalId(v string) *DeletePortalInput
SetPortalId sets the PortalId field's value.
func (s DeletePortalInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeletePortalInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeletePortalOutput struct { // The status of the portal, which contains a state (DELETING after successfully // calling this operation) and any error message. // // PortalStatus is a required field PortalStatus *PortalStatus `locationName:"portalStatus" type:"structure" required:"true"` // contains filtered or unexported fields }
func (s DeletePortalOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeletePortalOutput) SetPortalStatus(v *PortalStatus) *DeletePortalOutput
SetPortalStatus sets the PortalStatus field's value.
func (s DeletePortalOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteProjectInput struct { // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `location:"querystring" locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // The ID of the project. // // ProjectId is a required field ProjectId *string `location:"uri" locationName:"projectId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteProjectInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteProjectInput) SetClientToken(v string) *DeleteProjectInput
SetClientToken sets the ClientToken field's value.
func (s *DeleteProjectInput) SetProjectId(v string) *DeleteProjectInput
SetProjectId sets the ProjectId field's value.
func (s DeleteProjectInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteProjectInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteProjectOutput struct {
// contains filtered or unexported fields
}
func (s DeleteProjectOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteProjectOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteTimeSeriesInput struct { // The alias that identifies the time series. Alias *string `location:"querystring" locationName:"alias" min:"1" type:"string"` // The ID of the asset in which the asset property was created. AssetId *string `location:"querystring" locationName:"assetId" min:"36" type:"string"` // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // The ID of the asset property. PropertyId *string `location:"querystring" locationName:"propertyId" min:"36" type:"string"` // contains filtered or unexported fields }
func (s DeleteTimeSeriesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteTimeSeriesInput) SetAlias(v string) *DeleteTimeSeriesInput
SetAlias sets the Alias field's value.
func (s *DeleteTimeSeriesInput) SetAssetId(v string) *DeleteTimeSeriesInput
SetAssetId sets the AssetId field's value.
func (s *DeleteTimeSeriesInput) SetClientToken(v string) *DeleteTimeSeriesInput
SetClientToken sets the ClientToken field's value.
func (s *DeleteTimeSeriesInput) SetPropertyId(v string) *DeleteTimeSeriesInput
SetPropertyId sets the PropertyId field's value.
func (s DeleteTimeSeriesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteTimeSeriesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteTimeSeriesOutput struct {
// contains filtered or unexported fields
}
func (s DeleteTimeSeriesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DeleteTimeSeriesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeAccessPolicyInput struct { // The ID of the access policy. // // AccessPolicyId is a required field AccessPolicyId *string `location:"uri" locationName:"accessPolicyId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeAccessPolicyInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeAccessPolicyInput) SetAccessPolicyId(v string) *DescribeAccessPolicyInput
SetAccessPolicyId sets the AccessPolicyId field's value.
func (s DescribeAccessPolicyInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeAccessPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeAccessPolicyOutput struct { // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of the access policy, which has the following format. // // arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId} // // AccessPolicyArn is a required field AccessPolicyArn *string `locationName:"accessPolicyArn" min:"1" type:"string" required:"true"` // The date the access policy was created, in Unix epoch time. // // AccessPolicyCreationDate is a required field AccessPolicyCreationDate *time.Time `locationName:"accessPolicyCreationDate" type:"timestamp" required:"true"` // The ID of the access policy. // // AccessPolicyId is a required field AccessPolicyId *string `locationName:"accessPolicyId" min:"36" type:"string" required:"true"` // The identity (Amazon Web Services SSO user, Amazon Web Services SSO group, // or IAM user) to which this access policy applies. // // AccessPolicyIdentity is a required field AccessPolicyIdentity *Identity `locationName:"accessPolicyIdentity" type:"structure" required:"true"` // The date the access policy was last updated, in Unix epoch time. // // AccessPolicyLastUpdateDate is a required field AccessPolicyLastUpdateDate *time.Time `locationName:"accessPolicyLastUpdateDate" type:"timestamp" required:"true"` // The access policy permission. Note that a project ADMINISTRATOR is also known // as a project owner. // // AccessPolicyPermission is a required field AccessPolicyPermission *string `locationName:"accessPolicyPermission" type:"string" required:"true" enum:"Permission"` // The IoT SiteWise Monitor resource (portal or project) to which this access // policy provides access. // // AccessPolicyResource is a required field AccessPolicyResource *Resource `locationName:"accessPolicyResource" type:"structure" required:"true"` // contains filtered or unexported fields }
func (s DescribeAccessPolicyOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeAccessPolicyOutput) SetAccessPolicyArn(v string) *DescribeAccessPolicyOutput
SetAccessPolicyArn sets the AccessPolicyArn field's value.
func (s *DescribeAccessPolicyOutput) SetAccessPolicyCreationDate(v time.Time) *DescribeAccessPolicyOutput
SetAccessPolicyCreationDate sets the AccessPolicyCreationDate field's value.
func (s *DescribeAccessPolicyOutput) SetAccessPolicyId(v string) *DescribeAccessPolicyOutput
SetAccessPolicyId sets the AccessPolicyId field's value.
func (s *DescribeAccessPolicyOutput) SetAccessPolicyIdentity(v *Identity) *DescribeAccessPolicyOutput
SetAccessPolicyIdentity sets the AccessPolicyIdentity field's value.
func (s *DescribeAccessPolicyOutput) SetAccessPolicyLastUpdateDate(v time.Time) *DescribeAccessPolicyOutput
SetAccessPolicyLastUpdateDate sets the AccessPolicyLastUpdateDate field's value.
func (s *DescribeAccessPolicyOutput) SetAccessPolicyPermission(v string) *DescribeAccessPolicyOutput
SetAccessPolicyPermission sets the AccessPolicyPermission field's value.
func (s *DescribeAccessPolicyOutput) SetAccessPolicyResource(v *Resource) *DescribeAccessPolicyOutput
SetAccessPolicyResource sets the AccessPolicyResource field's value.
func (s DescribeAccessPolicyOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeAssetInput struct { // The ID of the asset. // // AssetId is a required field AssetId *string `location:"uri" locationName:"assetId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeAssetInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeAssetInput) SetAssetId(v string) *DescribeAssetInput
SetAssetId sets the AssetId field's value.
func (s DescribeAssetInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeAssetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeAssetModelInput struct { // The ID of the asset model. // // AssetModelId is a required field AssetModelId *string `location:"uri" locationName:"assetModelId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeAssetModelInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeAssetModelInput) SetAssetModelId(v string) *DescribeAssetModelInput
SetAssetModelId sets the AssetModelId field's value.
func (s DescribeAssetModelInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeAssetModelInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeAssetModelOutput 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} // // AssetModelArn is a required field AssetModelArn *string `locationName:"assetModelArn" min:"1" type:"string" required:"true"` // The list of composite asset models for the asset model. AssetModelCompositeModels []*AssetModelCompositeModel `locationName:"assetModelCompositeModels" type:"list"` // The date the asset model was created, in Unix epoch time. // // AssetModelCreationDate is a required field AssetModelCreationDate *time.Time `locationName:"assetModelCreationDate" type:"timestamp" required:"true"` // The asset model's description. // // AssetModelDescription is a required field AssetModelDescription *string `locationName:"assetModelDescription" min:"1" type:"string" required:"true"` // A list of asset model hierarchies that each contain a childAssetModelId and // a hierarchyId (named id). A hierarchy specifies allowed parent/child asset // relationships for an asset model. // // AssetModelHierarchies is a required field AssetModelHierarchies []*AssetModelHierarchy `locationName:"assetModelHierarchies" type:"list" required:"true"` // The ID of the asset model. // // AssetModelId is a required field AssetModelId *string `locationName:"assetModelId" min:"36" type:"string" required:"true"` // The date the asset model was last updated, in Unix epoch time. // // AssetModelLastUpdateDate is a required field AssetModelLastUpdateDate *time.Time `locationName:"assetModelLastUpdateDate" type:"timestamp" required:"true"` // The name of the asset model. // // AssetModelName is a required field AssetModelName *string `locationName:"assetModelName" min:"1" type:"string" required:"true"` // The list of asset properties for the asset model. // // This object doesn't include properties that you define in composite models. // You can find composite model properties in the assetModelCompositeModels // object. // // AssetModelProperties is a required field AssetModelProperties []*AssetModelProperty `locationName:"assetModelProperties" type:"list" required:"true"` // The current status of the asset model, which contains a state and any error // message. // // AssetModelStatus is a required field AssetModelStatus *AssetModelStatus `locationName:"assetModelStatus" type:"structure" required:"true"` // contains filtered or unexported fields }
func (s DescribeAssetModelOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeAssetModelOutput) SetAssetModelArn(v string) *DescribeAssetModelOutput
SetAssetModelArn sets the AssetModelArn field's value.
func (s *DescribeAssetModelOutput) SetAssetModelCompositeModels(v []*AssetModelCompositeModel) *DescribeAssetModelOutput
SetAssetModelCompositeModels sets the AssetModelCompositeModels field's value.
func (s *DescribeAssetModelOutput) SetAssetModelCreationDate(v time.Time) *DescribeAssetModelOutput
SetAssetModelCreationDate sets the AssetModelCreationDate field's value.
func (s *DescribeAssetModelOutput) SetAssetModelDescription(v string) *DescribeAssetModelOutput
SetAssetModelDescription sets the AssetModelDescription field's value.
func (s *DescribeAssetModelOutput) SetAssetModelHierarchies(v []*AssetModelHierarchy) *DescribeAssetModelOutput
SetAssetModelHierarchies sets the AssetModelHierarchies field's value.
func (s *DescribeAssetModelOutput) SetAssetModelId(v string) *DescribeAssetModelOutput
SetAssetModelId sets the AssetModelId field's value.
func (s *DescribeAssetModelOutput) SetAssetModelLastUpdateDate(v time.Time) *DescribeAssetModelOutput
SetAssetModelLastUpdateDate sets the AssetModelLastUpdateDate field's value.
func (s *DescribeAssetModelOutput) SetAssetModelName(v string) *DescribeAssetModelOutput
SetAssetModelName sets the AssetModelName field's value.
func (s *DescribeAssetModelOutput) SetAssetModelProperties(v []*AssetModelProperty) *DescribeAssetModelOutput
SetAssetModelProperties sets the AssetModelProperties field's value.
func (s *DescribeAssetModelOutput) SetAssetModelStatus(v *AssetModelStatus) *DescribeAssetModelOutput
SetAssetModelStatus sets the AssetModelStatus field's value.
func (s DescribeAssetModelOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeAssetOutput 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} // // AssetArn is a required field AssetArn *string `locationName:"assetArn" min:"1" type:"string" required:"true"` // The composite models for the asset. AssetCompositeModels []*AssetCompositeModel `locationName:"assetCompositeModels" type:"list"` // The date the asset was created, in Unix epoch time. // // AssetCreationDate is a required field AssetCreationDate *time.Time `locationName:"assetCreationDate" type:"timestamp" required:"true"` // A list of asset hierarchies that each contain a hierarchyId. A hierarchy // specifies allowed parent/child asset relationships. // // AssetHierarchies is a required field AssetHierarchies []*AssetHierarchy `locationName:"assetHierarchies" type:"list" required:"true"` // The ID of the asset. // // AssetId is a required field AssetId *string `locationName:"assetId" min:"36" type:"string" required:"true"` // The date the asset was last updated, in Unix epoch time. // // AssetLastUpdateDate is a required field AssetLastUpdateDate *time.Time `locationName:"assetLastUpdateDate" type:"timestamp" required:"true"` // The ID of the asset model that was used to create the asset. // // AssetModelId is a required field AssetModelId *string `locationName:"assetModelId" min:"36" type:"string" required:"true"` // The name of the asset. // // AssetName is a required field AssetName *string `locationName:"assetName" min:"1" type:"string" required:"true"` // The list of asset properties for the asset. // // This object doesn't include properties that you define in composite models. // You can find composite model properties in the assetCompositeModels object. // // AssetProperties is a required field AssetProperties []*AssetProperty `locationName:"assetProperties" type:"list" required:"true"` // The current status of the asset, which contains a state and any error message. // // AssetStatus is a required field AssetStatus *AssetStatus `locationName:"assetStatus" type:"structure" required:"true"` // contains filtered or unexported fields }
func (s DescribeAssetOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeAssetOutput) SetAssetArn(v string) *DescribeAssetOutput
SetAssetArn sets the AssetArn field's value.
func (s *DescribeAssetOutput) SetAssetCompositeModels(v []*AssetCompositeModel) *DescribeAssetOutput
SetAssetCompositeModels sets the AssetCompositeModels field's value.
func (s *DescribeAssetOutput) SetAssetCreationDate(v time.Time) *DescribeAssetOutput
SetAssetCreationDate sets the AssetCreationDate field's value.
func (s *DescribeAssetOutput) SetAssetHierarchies(v []*AssetHierarchy) *DescribeAssetOutput
SetAssetHierarchies sets the AssetHierarchies field's value.
func (s *DescribeAssetOutput) SetAssetId(v string) *DescribeAssetOutput
SetAssetId sets the AssetId field's value.
func (s *DescribeAssetOutput) SetAssetLastUpdateDate(v time.Time) *DescribeAssetOutput
SetAssetLastUpdateDate sets the AssetLastUpdateDate field's value.
func (s *DescribeAssetOutput) SetAssetModelId(v string) *DescribeAssetOutput
SetAssetModelId sets the AssetModelId field's value.
func (s *DescribeAssetOutput) SetAssetName(v string) *DescribeAssetOutput
SetAssetName sets the AssetName field's value.
func (s *DescribeAssetOutput) SetAssetProperties(v []*AssetProperty) *DescribeAssetOutput
SetAssetProperties sets the AssetProperties field's value.
func (s *DescribeAssetOutput) SetAssetStatus(v *AssetStatus) *DescribeAssetOutput
SetAssetStatus sets the AssetStatus field's value.
func (s DescribeAssetOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeAssetPropertyInput struct { // The ID of the asset. // // AssetId is a required field AssetId *string `location:"uri" locationName:"assetId" min:"36" type:"string" required:"true"` // The ID of the asset property. // // PropertyId is a required field PropertyId *string `location:"uri" locationName:"propertyId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeAssetPropertyInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeAssetPropertyInput) SetAssetId(v string) *DescribeAssetPropertyInput
SetAssetId sets the AssetId field's value.
func (s *DescribeAssetPropertyInput) SetPropertyId(v string) *DescribeAssetPropertyInput
SetPropertyId sets the PropertyId field's value.
func (s DescribeAssetPropertyInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeAssetPropertyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeAssetPropertyOutput struct { // The ID of the asset. // // AssetId is a required field AssetId *string `locationName:"assetId" min:"36" type:"string" required:"true"` // The ID of the asset model. // // AssetModelId is a required field AssetModelId *string `locationName:"assetModelId" min:"36" type:"string" required:"true"` // The name of the asset. // // AssetName is a required field AssetName *string `locationName:"assetName" min:"1" type:"string" required:"true"` // The asset property's definition, alias, and notification state. // // This response includes this object for normal asset properties. If you describe // an asset property in a composite model, this response includes the asset // property information in compositeModel. AssetProperty *Property `locationName:"assetProperty" type:"structure"` // The composite asset model that declares this asset property, if this asset // property exists in a composite model. CompositeModel *CompositeModelProperty `locationName:"compositeModel" type:"structure"` // contains filtered or unexported fields }
func (s DescribeAssetPropertyOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeAssetPropertyOutput) SetAssetId(v string) *DescribeAssetPropertyOutput
SetAssetId sets the AssetId field's value.
func (s *DescribeAssetPropertyOutput) SetAssetModelId(v string) *DescribeAssetPropertyOutput
SetAssetModelId sets the AssetModelId field's value.
func (s *DescribeAssetPropertyOutput) SetAssetName(v string) *DescribeAssetPropertyOutput
SetAssetName sets the AssetName field's value.
func (s *DescribeAssetPropertyOutput) SetAssetProperty(v *Property) *DescribeAssetPropertyOutput
SetAssetProperty sets the AssetProperty field's value.
func (s *DescribeAssetPropertyOutput) SetCompositeModel(v *CompositeModelProperty) *DescribeAssetPropertyOutput
SetCompositeModel sets the CompositeModel field's value.
func (s DescribeAssetPropertyOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeDashboardInput struct { // The ID of the dashboard. // // DashboardId is a required field DashboardId *string `location:"uri" locationName:"dashboardId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeDashboardInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDashboardInput) SetDashboardId(v string) *DescribeDashboardInput
SetDashboardId sets the DashboardId field's value.
func (s DescribeDashboardInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDashboardInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDashboardOutput struct { // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of the dashboard, which has the following format. // // arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId} // // DashboardArn is a required field DashboardArn *string `locationName:"dashboardArn" min:"1" type:"string" required:"true"` // The date the dashboard was created, in Unix epoch time. // // DashboardCreationDate is a required field DashboardCreationDate *time.Time `locationName:"dashboardCreationDate" type:"timestamp" required:"true"` // The dashboard's definition JSON literal. For detailed information, see Creating // dashboards (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) // in the IoT SiteWise User Guide. // // DashboardDefinition is a required field DashboardDefinition *string `locationName:"dashboardDefinition" type:"string" required:"true"` // The dashboard's description. DashboardDescription *string `locationName:"dashboardDescription" min:"1" type:"string"` // The ID of the dashboard. // // DashboardId is a required field DashboardId *string `locationName:"dashboardId" min:"36" type:"string" required:"true"` // The date the dashboard was last updated, in Unix epoch time. // // DashboardLastUpdateDate is a required field DashboardLastUpdateDate *time.Time `locationName:"dashboardLastUpdateDate" type:"timestamp" required:"true"` // The name of the dashboard. // // DashboardName is a required field DashboardName *string `locationName:"dashboardName" min:"1" type:"string" required:"true"` // The ID of the project that the dashboard is in. // // ProjectId is a required field ProjectId *string `locationName:"projectId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeDashboardOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDashboardOutput) SetDashboardArn(v string) *DescribeDashboardOutput
SetDashboardArn sets the DashboardArn field's value.
func (s *DescribeDashboardOutput) SetDashboardCreationDate(v time.Time) *DescribeDashboardOutput
SetDashboardCreationDate sets the DashboardCreationDate field's value.
func (s *DescribeDashboardOutput) SetDashboardDefinition(v string) *DescribeDashboardOutput
SetDashboardDefinition sets the DashboardDefinition field's value.
func (s *DescribeDashboardOutput) SetDashboardDescription(v string) *DescribeDashboardOutput
SetDashboardDescription sets the DashboardDescription field's value.
func (s *DescribeDashboardOutput) SetDashboardId(v string) *DescribeDashboardOutput
SetDashboardId sets the DashboardId field's value.
func (s *DescribeDashboardOutput) SetDashboardLastUpdateDate(v time.Time) *DescribeDashboardOutput
SetDashboardLastUpdateDate sets the DashboardLastUpdateDate field's value.
func (s *DescribeDashboardOutput) SetDashboardName(v string) *DescribeDashboardOutput
SetDashboardName sets the DashboardName field's value.
func (s *DescribeDashboardOutput) SetProjectId(v string) *DescribeDashboardOutput
SetProjectId sets the ProjectId field's value.
func (s DescribeDashboardOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeDefaultEncryptionConfigurationInput struct {
// contains filtered or unexported fields
}
func (s DescribeDefaultEncryptionConfigurationInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DescribeDefaultEncryptionConfigurationInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeDefaultEncryptionConfigurationOutput struct { // The status of the account configuration. This contains the ConfigurationState. // If there's an error, it also contains the ErrorDetails. // // ConfigurationStatus is a required field ConfigurationStatus *ConfigurationStatus `locationName:"configurationStatus" type:"structure" required:"true"` // The type of encryption used for the encryption configuration. // // EncryptionType is a required field EncryptionType *string `locationName:"encryptionType" type:"string" required:"true" enum:"EncryptionType"` // The key ARN of the customer managed key used for KMS encryption if you use // KMS_BASED_ENCRYPTION. KmsKeyArn *string `locationName:"kmsKeyArn" min:"1" type:"string"` // contains filtered or unexported fields }
func (s DescribeDefaultEncryptionConfigurationOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDefaultEncryptionConfigurationOutput) SetConfigurationStatus(v *ConfigurationStatus) *DescribeDefaultEncryptionConfigurationOutput
SetConfigurationStatus sets the ConfigurationStatus field's value.
func (s *DescribeDefaultEncryptionConfigurationOutput) SetEncryptionType(v string) *DescribeDefaultEncryptionConfigurationOutput
SetEncryptionType sets the EncryptionType field's value.
func (s *DescribeDefaultEncryptionConfigurationOutput) SetKmsKeyArn(v string) *DescribeDefaultEncryptionConfigurationOutput
SetKmsKeyArn sets the KmsKeyArn field's value.
func (s DescribeDefaultEncryptionConfigurationOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeGatewayCapabilityConfigurationInput 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. // // CapabilityNamespace is a required field CapabilityNamespace *string `location:"uri" locationName:"capabilityNamespace" min:"1" type:"string" required:"true"` // The ID of the gateway that defines the capability configuration. // // GatewayId is a required field GatewayId *string `location:"uri" locationName:"gatewayId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeGatewayCapabilityConfigurationInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeGatewayCapabilityConfigurationInput) SetCapabilityNamespace(v string) *DescribeGatewayCapabilityConfigurationInput
SetCapabilityNamespace sets the CapabilityNamespace field's value.
func (s *DescribeGatewayCapabilityConfigurationInput) SetGatewayId(v string) *DescribeGatewayCapabilityConfigurationInput
SetGatewayId sets the GatewayId field's value.
func (s DescribeGatewayCapabilityConfigurationInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeGatewayCapabilityConfigurationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeGatewayCapabilityConfigurationOutput struct { // The JSON document that defines the gateway capability's configuration. For // more information, see Configuring data sources (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli) // in the IoT SiteWise User Guide. // // CapabilityConfiguration is a required field CapabilityConfiguration *string `locationName:"capabilityConfiguration" min:"1" type:"string" required:"true"` // The namespace of the gateway capability. // // CapabilityNamespace is a required field CapabilityNamespace *string `locationName:"capabilityNamespace" min:"1" type:"string" required:"true"` // The synchronization status of the capability configuration. The sync status // can be one of the following: // // * IN_SYNC – The gateway is running the capability configuration. // // * OUT_OF_SYNC – The gateway hasn't received the capability configuration. // // * SYNC_FAILED – The gateway rejected the capability configuration. // // CapabilitySyncStatus is a required field CapabilitySyncStatus *string `locationName:"capabilitySyncStatus" type:"string" required:"true" enum:"CapabilitySyncStatus"` // The ID of the gateway that defines the capability configuration. // // GatewayId is a required field GatewayId *string `locationName:"gatewayId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeGatewayCapabilityConfigurationOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeGatewayCapabilityConfigurationOutput) SetCapabilityConfiguration(v string) *DescribeGatewayCapabilityConfigurationOutput
SetCapabilityConfiguration sets the CapabilityConfiguration field's value.
func (s *DescribeGatewayCapabilityConfigurationOutput) SetCapabilityNamespace(v string) *DescribeGatewayCapabilityConfigurationOutput
SetCapabilityNamespace sets the CapabilityNamespace field's value.
func (s *DescribeGatewayCapabilityConfigurationOutput) SetCapabilitySyncStatus(v string) *DescribeGatewayCapabilityConfigurationOutput
SetCapabilitySyncStatus sets the CapabilitySyncStatus field's value.
func (s *DescribeGatewayCapabilityConfigurationOutput) SetGatewayId(v string) *DescribeGatewayCapabilityConfigurationOutput
SetGatewayId sets the GatewayId field's value.
func (s DescribeGatewayCapabilityConfigurationOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeGatewayInput struct { // The ID of the gateway device. // // GatewayId is a required field GatewayId *string `location:"uri" locationName:"gatewayId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeGatewayInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeGatewayInput) SetGatewayId(v string) *DescribeGatewayInput
SetGatewayId sets the GatewayId field's value.
func (s DescribeGatewayInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeGatewayInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeGatewayOutput struct { // The date the gateway was created, in Unix epoch time. // // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"` // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of the gateway, which has the following format. // // arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId} // // GatewayArn is a required field GatewayArn *string `locationName:"gatewayArn" min:"1" type:"string" required:"true"` // 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 is a required field GatewayCapabilitySummaries []*GatewayCapabilitySummary `locationName:"gatewayCapabilitySummaries" type:"list" required:"true"` // The ID of the gateway device. // // GatewayId is a required field GatewayId *string `locationName:"gatewayId" min:"36" type:"string" required:"true"` // The name of the gateway. // // GatewayName is a required field GatewayName *string `locationName:"gatewayName" min:"1" type:"string" required:"true"` // The gateway's platform. GatewayPlatform *GatewayPlatform `locationName:"gatewayPlatform" type:"structure"` // The date the gateway was last updated, in Unix epoch time. // // LastUpdateDate is a required field LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp" required:"true"` // contains filtered or unexported fields }
func (s DescribeGatewayOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeGatewayOutput) SetCreationDate(v time.Time) *DescribeGatewayOutput
SetCreationDate sets the CreationDate field's value.
func (s *DescribeGatewayOutput) SetGatewayArn(v string) *DescribeGatewayOutput
SetGatewayArn sets the GatewayArn field's value.
func (s *DescribeGatewayOutput) SetGatewayCapabilitySummaries(v []*GatewayCapabilitySummary) *DescribeGatewayOutput
SetGatewayCapabilitySummaries sets the GatewayCapabilitySummaries field's value.
func (s *DescribeGatewayOutput) SetGatewayId(v string) *DescribeGatewayOutput
SetGatewayId sets the GatewayId field's value.
func (s *DescribeGatewayOutput) SetGatewayName(v string) *DescribeGatewayOutput
SetGatewayName sets the GatewayName field's value.
func (s *DescribeGatewayOutput) SetGatewayPlatform(v *GatewayPlatform) *DescribeGatewayOutput
SetGatewayPlatform sets the GatewayPlatform field's value.
func (s *DescribeGatewayOutput) SetLastUpdateDate(v time.Time) *DescribeGatewayOutput
SetLastUpdateDate sets the LastUpdateDate field's value.
func (s DescribeGatewayOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeLoggingOptionsInput struct {
// contains filtered or unexported fields
}
func (s DescribeLoggingOptionsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DescribeLoggingOptionsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeLoggingOptionsOutput struct { // The current logging options. // // LoggingOptions is a required field LoggingOptions *LoggingOptions `locationName:"loggingOptions" type:"structure" required:"true"` // contains filtered or unexported fields }
func (s DescribeLoggingOptionsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeLoggingOptionsOutput) SetLoggingOptions(v *LoggingOptions) *DescribeLoggingOptionsOutput
SetLoggingOptions sets the LoggingOptions field's value.
func (s DescribeLoggingOptionsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribePortalInput struct { // The ID of the portal. // // PortalId is a required field PortalId *string `location:"uri" locationName:"portalId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribePortalInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribePortalInput) SetPortalId(v string) *DescribePortalInput
SetPortalId sets the PortalId field's value.
func (s DescribePortalInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribePortalInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribePortalOutput struct { // Contains the configuration information of an alarm created in an IoT SiteWise // Monitor portal. Alarms *Alarms `locationName:"alarms" type:"structure"` // The email address that sends alarm notifications. NotificationSenderEmail *string `locationName:"notificationSenderEmail" min:"1" type:"string"` // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of the portal, which has the following format. // // arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} // // PortalArn is a required field PortalArn *string `locationName:"portalArn" min:"1" type:"string" required:"true"` // The service to use to authenticate users to the portal. PortalAuthMode *string `locationName:"portalAuthMode" type:"string" enum:"AuthMode"` // The Amazon Web Services SSO application generated client ID (used with Amazon // Web Services SSO APIs). IoT SiteWise includes portalClientId for only portals // that use Amazon Web Services SSO to authenticate users. // // PortalClientId is a required field PortalClientId *string `locationName:"portalClientId" min:"1" type:"string" required:"true"` // The Amazon Web Services administrator's contact email address. // // PortalContactEmail is a required field PortalContactEmail *string `locationName:"portalContactEmail" min:"1" type:"string" required:"true"` // The date the portal was created, in Unix epoch time. // // PortalCreationDate is a required field PortalCreationDate *time.Time `locationName:"portalCreationDate" type:"timestamp" required:"true"` // The portal's description. PortalDescription *string `locationName:"portalDescription" min:"1" type:"string"` // The ID of the portal. // // PortalId is a required field PortalId *string `locationName:"portalId" min:"36" type:"string" required:"true"` // The date the portal was last updated, in Unix epoch time. // // PortalLastUpdateDate is a required field PortalLastUpdateDate *time.Time `locationName:"portalLastUpdateDate" type:"timestamp" required:"true"` // The portal's logo image, which is available at a URL. PortalLogoImageLocation *ImageLocation `locationName:"portalLogoImageLocation" type:"structure"` // The name of the portal. // // PortalName is a required field PortalName *string `locationName:"portalName" min:"1" type:"string" required:"true"` // The URL for the IoT SiteWise Monitor portal. You can use this URL to access // portals that use Amazon Web Services SSO 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. // // PortalStartUrl is a required field PortalStartUrl *string `locationName:"portalStartUrl" min:"1" type:"string" required:"true"` // The current status of the portal, which contains a state and any error message. // // PortalStatus is a required field PortalStatus *PortalStatus `locationName:"portalStatus" type:"structure" required:"true"` // 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 IoT SiteWise // resources on your behalf. For more information, see Using service roles for // IoT SiteWise Monitor (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) // in the IoT SiteWise User Guide. RoleArn *string `locationName:"roleArn" min:"1" type:"string"` // contains filtered or unexported fields }
func (s DescribePortalOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribePortalOutput) SetAlarms(v *Alarms) *DescribePortalOutput
SetAlarms sets the Alarms field's value.
func (s *DescribePortalOutput) SetNotificationSenderEmail(v string) *DescribePortalOutput
SetNotificationSenderEmail sets the NotificationSenderEmail field's value.
func (s *DescribePortalOutput) SetPortalArn(v string) *DescribePortalOutput
SetPortalArn sets the PortalArn field's value.
func (s *DescribePortalOutput) SetPortalAuthMode(v string) *DescribePortalOutput
SetPortalAuthMode sets the PortalAuthMode field's value.
func (s *DescribePortalOutput) SetPortalClientId(v string) *DescribePortalOutput
SetPortalClientId sets the PortalClientId field's value.
func (s *DescribePortalOutput) SetPortalContactEmail(v string) *DescribePortalOutput
SetPortalContactEmail sets the PortalContactEmail field's value.
func (s *DescribePortalOutput) SetPortalCreationDate(v time.Time) *DescribePortalOutput
SetPortalCreationDate sets the PortalCreationDate field's value.
func (s *DescribePortalOutput) SetPortalDescription(v string) *DescribePortalOutput
SetPortalDescription sets the PortalDescription field's value.
func (s *DescribePortalOutput) SetPortalId(v string) *DescribePortalOutput
SetPortalId sets the PortalId field's value.
func (s *DescribePortalOutput) SetPortalLastUpdateDate(v time.Time) *DescribePortalOutput
SetPortalLastUpdateDate sets the PortalLastUpdateDate field's value.
func (s *DescribePortalOutput) SetPortalLogoImageLocation(v *ImageLocation) *DescribePortalOutput
SetPortalLogoImageLocation sets the PortalLogoImageLocation field's value.
func (s *DescribePortalOutput) SetPortalName(v string) *DescribePortalOutput
SetPortalName sets the PortalName field's value.
func (s *DescribePortalOutput) SetPortalStartUrl(v string) *DescribePortalOutput
SetPortalStartUrl sets the PortalStartUrl field's value.
func (s *DescribePortalOutput) SetPortalStatus(v *PortalStatus) *DescribePortalOutput
SetPortalStatus sets the PortalStatus field's value.
func (s *DescribePortalOutput) SetRoleArn(v string) *DescribePortalOutput
SetRoleArn sets the RoleArn field's value.
func (s DescribePortalOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeProjectInput struct { // The ID of the project. // // ProjectId is a required field ProjectId *string `location:"uri" locationName:"projectId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeProjectInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeProjectInput) SetProjectId(v string) *DescribeProjectInput
SetProjectId sets the ProjectId field's value.
func (s DescribeProjectInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeProjectInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeProjectOutput struct { // The ID of the portal that the project is in. // // PortalId is a required field PortalId *string `locationName:"portalId" min:"36" type:"string" required:"true"` // The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) // of the project, which has the following format. // // arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId} // // ProjectArn is a required field ProjectArn *string `locationName:"projectArn" min:"1" type:"string" required:"true"` // The date the project was created, in Unix epoch time. // // ProjectCreationDate is a required field ProjectCreationDate *time.Time `locationName:"projectCreationDate" type:"timestamp" required:"true"` // The project's description. ProjectDescription *string `locationName:"projectDescription" min:"1" type:"string"` // The ID of the project. // // ProjectId is a required field ProjectId *string `locationName:"projectId" min:"36" type:"string" required:"true"` // The date the project was last updated, in Unix epoch time. // // ProjectLastUpdateDate is a required field ProjectLastUpdateDate *time.Time `locationName:"projectLastUpdateDate" type:"timestamp" required:"true"` // The name of the project. // // ProjectName is a required field ProjectName *string `locationName:"projectName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeProjectOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeProjectOutput) SetPortalId(v string) *DescribeProjectOutput
SetPortalId sets the PortalId field's value.
func (s *DescribeProjectOutput) SetProjectArn(v string) *DescribeProjectOutput
SetProjectArn sets the ProjectArn field's value.
func (s *DescribeProjectOutput) SetProjectCreationDate(v time.Time) *DescribeProjectOutput
SetProjectCreationDate sets the ProjectCreationDate field's value.
func (s *DescribeProjectOutput) SetProjectDescription(v string) *DescribeProjectOutput
SetProjectDescription sets the ProjectDescription field's value.
func (s *DescribeProjectOutput) SetProjectId(v string) *DescribeProjectOutput
SetProjectId sets the ProjectId field's value.
func (s *DescribeProjectOutput) SetProjectLastUpdateDate(v time.Time) *DescribeProjectOutput
SetProjectLastUpdateDate sets the ProjectLastUpdateDate field's value.
func (s *DescribeProjectOutput) SetProjectName(v string) *DescribeProjectOutput
SetProjectName sets the ProjectName field's value.
func (s DescribeProjectOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeStorageConfigurationInput struct {
// contains filtered or unexported fields
}
func (s DescribeStorageConfigurationInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DescribeStorageConfigurationInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeStorageConfigurationOutput struct { // Contains current status information for the configuration. // // ConfigurationStatus is a required field ConfigurationStatus *ConfigurationStatus `locationName:"configurationStatus" type:"structure" required:"true"` // Contains the storage configuration for time series (data streams) that aren't // associated with asset properties. The disassociatedDataStorage can be one // of the following values: // // * ENABLED – IoT SiteWise accepts time series that aren't associated // with asset properties. After the disassociatedDataStorage is enabled, // you can't disable it. // // * DISABLED – IoT SiteWise doesn't accept time series (data streams) // that aren't associated with asset properties. // // For more information, see Data streams (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html) // in the IoT SiteWise User Guide. DisassociatedDataStorage *string `locationName:"disassociatedDataStorage" type:"string" enum:"DisassociatedDataStorageState"` // The date the storage configuration was last updated, in Unix epoch time. LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp"` // Contains information about the storage destination. MultiLayerStorage *MultiLayerStorage `locationName:"multiLayerStorage" type:"structure"` // How many days your data is kept in the hot tier. By default, your data is // kept indefinitely in the hot tier. RetentionPeriod *RetentionPeriod `locationName:"retentionPeriod" type:"structure"` // The storage tier that you specified for your data. The storageType parameter // can be one of the following values: // // * SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot // tier. The hot tier is a service-managed database. // // * MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold // tier and the cold tier. The cold tier is a customer-managed Amazon S3 // bucket. // // StorageType is a required field StorageType *string `locationName:"storageType" type:"string" required:"true" enum:"StorageType"` // contains filtered or unexported fields }
func (s DescribeStorageConfigurationOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeStorageConfigurationOutput) SetConfigurationStatus(v *ConfigurationStatus) *DescribeStorageConfigurationOutput
SetConfigurationStatus sets the ConfigurationStatus field's value.
func (s *DescribeStorageConfigurationOutput) SetDisassociatedDataStorage(v string) *DescribeStorageConfigurationOutput
SetDisassociatedDataStorage sets the DisassociatedDataStorage field's value.
func (s *DescribeStorageConfigurationOutput) SetLastUpdateDate(v time.Time) *DescribeStorageConfigurationOutput
SetLastUpdateDate sets the LastUpdateDate field's value.
func (s *DescribeStorageConfigurationOutput) SetMultiLayerStorage(v *MultiLayerStorage) *DescribeStorageConfigurationOutput
SetMultiLayerStorage sets the MultiLayerStorage field's value.
func (s *DescribeStorageConfigurationOutput) SetRetentionPeriod(v *RetentionPeriod) *DescribeStorageConfigurationOutput
SetRetentionPeriod sets the RetentionPeriod field's value.
func (s *DescribeStorageConfigurationOutput) SetStorageType(v string) *DescribeStorageConfigurationOutput
SetStorageType sets the StorageType field's value.
func (s DescribeStorageConfigurationOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeTimeSeriesInput struct { // The alias that identifies the time series. Alias *string `location:"querystring" locationName:"alias" min:"1" type:"string"` // The ID of the asset in which the asset property was created. AssetId *string `location:"querystring" locationName:"assetId" min:"36" type:"string"` // The ID of the asset property. PropertyId *string `location:"querystring" locationName:"propertyId" min:"36" type:"string"` // contains filtered or unexported fields }
func (s DescribeTimeSeriesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeTimeSeriesInput) SetAlias(v string) *DescribeTimeSeriesInput
SetAlias sets the Alias field's value.
func (s *DescribeTimeSeriesInput) SetAssetId(v string) *DescribeTimeSeriesInput
SetAssetId sets the AssetId field's value.
func (s *DescribeTimeSeriesInput) SetPropertyId(v string) *DescribeTimeSeriesInput
SetPropertyId sets the PropertyId field's value.
func (s DescribeTimeSeriesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeTimeSeriesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeTimeSeriesOutput struct { // The alias that identifies the time series. Alias *string `locationName:"alias" min:"1" type:"string"` // The ID of the asset in which the asset property was created. AssetId *string `locationName:"assetId" min:"36" type:"string"` // 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. // // DataType is a required field DataType *string `locationName:"dataType" type:"string" required:"true" enum:"PropertyDataType"` // 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 `locationName:"dataTypeSpec" min:"1" type:"string"` // The ID of the asset property. PropertyId *string `locationName:"propertyId" min:"36" type:"string"` // The date that the time series was created, in Unix epoch time. // // TimeSeriesCreationDate is a required field TimeSeriesCreationDate *time.Time `locationName:"timeSeriesCreationDate" type:"timestamp" required:"true"` // The ID of the time series. // // TimeSeriesId is a required field TimeSeriesId *string `locationName:"timeSeriesId" min:"36" type:"string" required:"true"` // The date that the time series was last updated, in Unix epoch time. // // TimeSeriesLastUpdateDate is a required field TimeSeriesLastUpdateDate *time.Time `locationName:"timeSeriesLastUpdateDate" type:"timestamp" required:"true"` // contains filtered or unexported fields }
func (s DescribeTimeSeriesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeTimeSeriesOutput) SetAlias(v string) *DescribeTimeSeriesOutput
SetAlias sets the Alias field's value.
func (s *DescribeTimeSeriesOutput) SetAssetId(v string) *DescribeTimeSeriesOutput
SetAssetId sets the AssetId field's value.
func (s *DescribeTimeSeriesOutput) SetDataType(v string) *DescribeTimeSeriesOutput
SetDataType sets the DataType field's value.
func (s *DescribeTimeSeriesOutput) SetDataTypeSpec(v string) *DescribeTimeSeriesOutput
SetDataTypeSpec sets the DataTypeSpec field's value.
func (s *DescribeTimeSeriesOutput) SetPropertyId(v string) *DescribeTimeSeriesOutput
SetPropertyId sets the PropertyId field's value.
func (s *DescribeTimeSeriesOutput) SetTimeSeriesCreationDate(v time.Time) *DescribeTimeSeriesOutput
SetTimeSeriesCreationDate sets the TimeSeriesCreationDate field's value.
func (s *DescribeTimeSeriesOutput) SetTimeSeriesId(v string) *DescribeTimeSeriesOutput
SetTimeSeriesId sets the TimeSeriesId field's value.
func (s *DescribeTimeSeriesOutput) SetTimeSeriesLastUpdateDate(v time.Time) *DescribeTimeSeriesOutput
SetTimeSeriesLastUpdateDate sets the TimeSeriesLastUpdateDate field's value.
func (s DescribeTimeSeriesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DetailedError struct { // The error code. // // Code is a required field Code *string `locationName:"code" type:"string" required:"true" enum:"DetailedErrorCode"` // The error message. // // Message is a required field Message *string `locationName:"message" type:"string" required:"true"` // contains filtered or unexported fields }
Contains detailed error information.
func (s DetailedError) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DetailedError) SetCode(v string) *DetailedError
SetCode sets the Code field's value.
func (s *DetailedError) SetMessage(v string) *DetailedError
SetMessage sets the Message field's value.
func (s DetailedError) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DisassociateAssetsInput struct { // The ID of the parent asset from which to disassociate the child asset. // // AssetId is a required field AssetId *string `location:"uri" locationName:"assetId" min:"36" type:"string" required:"true"` // The ID of the child asset to disassociate. // // ChildAssetId is a required field ChildAssetId *string `locationName:"childAssetId" min:"36" type:"string" required:"true"` // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // The ID of a hierarchy in the parent asset's model. Hierarchies allow different // groupings of assets to be formed that all come from the same asset model. // You can use the hierarchy ID to identify the correct asset to disassociate. // For more information, see Asset hierarchies (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html) // in the IoT SiteWise User Guide. // // HierarchyId is a required field HierarchyId *string `locationName:"hierarchyId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DisassociateAssetsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DisassociateAssetsInput) SetAssetId(v string) *DisassociateAssetsInput
SetAssetId sets the AssetId field's value.
func (s *DisassociateAssetsInput) SetChildAssetId(v string) *DisassociateAssetsInput
SetChildAssetId sets the ChildAssetId field's value.
func (s *DisassociateAssetsInput) SetClientToken(v string) *DisassociateAssetsInput
SetClientToken sets the ClientToken field's value.
func (s *DisassociateAssetsInput) SetHierarchyId(v string) *DisassociateAssetsInput
SetHierarchyId sets the HierarchyId field's value.
func (s DisassociateAssetsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DisassociateAssetsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DisassociateAssetsOutput struct {
// contains filtered or unexported fields
}
func (s DisassociateAssetsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DisassociateAssetsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DisassociateTimeSeriesFromAssetPropertyInput struct { // The alias that identifies the time series. // // Alias is a required field Alias *string `location:"querystring" locationName:"alias" min:"1" type:"string" required:"true"` // The ID of the asset in which the asset property was created. // // AssetId is a required field AssetId *string `location:"querystring" locationName:"assetId" min:"36" type:"string" required:"true"` // A unique case-sensitive identifier that you can provide to ensure the idempotency // of the request. Don't reuse this client token if a new idempotent request // is required. ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"` // The ID of the asset property. // // PropertyId is a required field PropertyId *string `location:"querystring" locationName:"propertyId" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DisassociateTimeSeriesFromAssetPropertyInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DisassociateTimeSeriesFromAssetPropertyInput) SetAlias(v string) *DisassociateTimeSeriesFromAssetPropertyInput
SetAlias sets the Alias field's value.
func (s *DisassociateTimeSeriesFromAssetPropertyInput) SetAssetId(v string) *DisassociateTimeSeriesFromAssetPropertyInput
SetAssetId sets the AssetId field's value.
func (s *DisassociateTimeSeriesFromAssetPropertyInput) SetClientToken(v string) *DisassociateTimeSeriesFromAssetPropertyInput
SetClientToken sets the ClientToken field's value.
func (s *DisassociateTimeSeriesFromAssetPropertyInput) SetPropertyId(v string) *DisassociateTimeSeriesFromAssetPropertyInput
SetPropertyId sets the PropertyId field's value.
func (s DisassociateTimeSeriesFromAssetPropertyInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DisassociateTimeSeriesFromAssetPropertyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DisassociateTimeSeriesFromAssetPropertyOutput struct {
// contains filtered or unexported fields
}
func (s DisassociateTimeSeriesFromAssetPropertyOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s DisassociateTimeSeriesFromAssetPropertyOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ErrorDetails struct { // The error code. // // Code is a required field Code *string `locationName:"code" type:"string" required:"true" enum:"ErrorCode"` // A list of detailed errors. Details []*DetailedError `locationName:"details" type:"list"` // The error message. // // Message is a required field Message *string `locationName:"message" type:"string" required:"true"` // contains filtered or unexported fields }
Contains the details of an IoT SiteWise error.
func (s ErrorDetails) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ErrorDetails) SetCode(v string) *ErrorDetails
SetCode sets the Code field's value.
func (s *ErrorDetails) SetDetails(v []*DetailedError) *ErrorDetails
SetDetails sets the Details field's value.
func (s *ErrorDetails) SetMessage(v string) *ErrorDetails
SetMessage sets the Message field's value.
func (s ErrorDetails) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ExpressionVariable struct { // The friendly name of the variable to be used in the expression. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The variable that identifies an asset property from which to use values. // // Value is a required field Value *VariableValue `locationName:"value" type:"structure" required:"true"` // contains filtered or unexported fields }
Contains expression variable information.
func (s ExpressionVariable) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExpressionVariable) SetName(v string) *ExpressionVariable
SetName sets the Name field's value.
func (s *ExpressionVariable) SetValue(v *VariableValue) *ExpressionVariable
SetValue sets the Value field's value.
func (s ExpressionVariable) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExpressionVariable) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ForwardingConfig struct { // The forwarding state for the given property. // // State is a required field State *string `locationName:"state" type:"string" required:"true" enum:"ForwardingConfigState"` // contains filtered or unexported fields }
The forwarding configuration for a given property.
func (s ForwardingConfig) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ForwardingConfig) SetState(v string) *ForwardingConfig
SetState sets the State field's value.
func (s ForwardingConfig) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ForwardingConfig) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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. // // CapabilityNamespace is a required field CapabilityNamespace *string `locationName:"capabilityNamespace" min:"1" type:"string" required:"true"` // The synchronization status of the capability configuration. The sync status // can be one of the following: // // * IN_SYNC – The gateway is running the capability configuration. // // * OUT_OF_SYNC – The gateway hasn't received the capability configuration. // // * SYNC_FAILED – The gateway rejected the capability configuration. // // CapabilitySyncStatus is a required field CapabilitySyncStatus *string `locationName:"capabilitySyncStatus" type:"string" required:"true" enum:"CapabilitySyncStatus"` // contains filtered or unexported fields }
Contains a summary of a gateway capability configuration.
func (s GatewayCapabilitySummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GatewayCapabilitySummary) SetCapabilityNamespace(v string) *GatewayCapabilitySummary
SetCapabilityNamespace sets the CapabilityNamespace field's value.
func (s *GatewayCapabilitySummary) SetCapabilitySyncStatus(v string) *GatewayCapabilitySummary
SetCapabilitySyncStatus sets the CapabilitySyncStatus field's value.
func (s GatewayCapabilitySummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GatewayPlatform struct { // A gateway that runs on IoT Greengrass. Greengrass *Greengrass `locationName:"greengrass" type:"structure"` // A gateway that runs on IoT Greengrass V2. GreengrassV2 *GreengrassV2 `locationName:"greengrassV2" type:"structure"` // contains filtered or unexported fields }
Contains a gateway's platform information.
func (s GatewayPlatform) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GatewayPlatform) SetGreengrass(v *Greengrass) *GatewayPlatform
SetGreengrass sets the Greengrass field's value.
func (s *GatewayPlatform) SetGreengrassV2(v *GreengrassV2) *GatewayPlatform
SetGreengrassV2 sets the GreengrassV2 field's value.
func (s GatewayPlatform) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GatewayPlatform) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GatewaySummary struct { // The date the gateway was created, in Unix epoch time. // // CreationDate is a required field CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"` // 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 `locationName:"gatewayCapabilitySummaries" type:"list"` // The ID of the gateway device. // // GatewayId is a required field GatewayId *string `locationName:"gatewayId" min:"36" type:"string" required:"true"` // The name of the asset. // // GatewayName is a required field GatewayName *string `locationName:"gatewayName" min:"1" type:"string" required:"true"` // Contains a gateway's platform information. GatewayPlatform *GatewayPlatform `locationName:"gatewayPlatform" type:"structure"` // The date the gateway was last updated, in Unix epoch time. // // LastUpdateDate is a required field LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp" required:"true"` // contains filtered or unexported fields }
Contains a summary of a gateway.
func (s GatewaySummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GatewaySummary) SetCreationDate(v time.Time) *GatewaySummary
SetCreationDate sets the CreationDate field's value.
func (s *GatewaySummary) SetGatewayCapabilitySummaries(v []*GatewayCapabilitySummary) *GatewaySummary
SetGatewayCapabilitySummaries sets the GatewayCapabilitySummaries field's value.
func (s *GatewaySummary) SetGatewayId(v string) *GatewaySummary
SetGatewayId sets the GatewayId field's value.
func (s *GatewaySummary) SetGatewayName(v string) *GatewaySummary
SetGatewayName sets the GatewayName field's value.
func (s *GatewaySummary) SetGatewayPlatform(v *GatewayPlatform) *GatewaySummary
SetGatewayPlatform sets the GatewayPlatform field's value.
func (s *GatewaySummary) SetLastUpdateDate(v time.Time) *GatewaySummary
SetLastUpdateDate sets the LastUpdateDate field's value.
func (s GatewaySummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetAssetPropertyAggregatesInput struct { // The data aggregating function. // // AggregateTypes is a required field AggregateTypes []*string `location:"querystring" locationName:"aggregateTypes" min:"1" type:"list" required:"true" enum:"AggregateType"` // The ID of the asset. AssetId *string `location:"querystring" locationName:"assetId" min:"36" type:"string"` // The inclusive end of the range from which to query historical data, expressed // in seconds in Unix epoch time. // // EndDate is a required field EndDate *time.Time `location:"querystring" locationName:"endDate" type:"timestamp" required:"true"` // The maximum number of results to return for each paginated request. // // Default: 100 MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token to be used for the next set of paginated results. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. PropertyAlias *string `location:"querystring" locationName:"propertyAlias" min:"1" type:"string"` // The ID of the asset property. PropertyId *string `location:"querystring" locationName:"propertyId" min:"36" type:"string"` // The quality by which to filter asset data. Qualities []*string `location:"querystring" locationName:"qualities" min:"1" type:"list" enum:"Quality"` // The time interval over which to aggregate data. // // Resolution is a required field Resolution *string `location:"querystring" locationName:"resolution" min:"2" type:"string" required:"true"` // The exclusive start of the range from which to query historical data, expressed // in seconds in Unix epoch time. // // StartDate is a required field StartDate *time.Time `location:"querystring" locationName:"startDate" type:"timestamp" required:"true"` // The chronological sorting order of the requested information. // // Default: ASCENDING TimeOrdering *string `location:"querystring" locationName:"timeOrdering" type:"string" enum:"TimeOrdering"` // contains filtered or unexported fields }
func (s GetAssetPropertyAggregatesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetAssetPropertyAggregatesInput) SetAggregateTypes(v []*string) *GetAssetPropertyAggregatesInput
SetAggregateTypes sets the AggregateTypes field's value.
func (s *GetAssetPropertyAggregatesInput) SetAssetId(v string) *GetAssetPropertyAggregatesInput
SetAssetId sets the AssetId field's value.
func (s *GetAssetPropertyAggregatesInput) SetEndDate(v time.Time) *GetAssetPropertyAggregatesInput
SetEndDate sets the EndDate field's value.
func (s *GetAssetPropertyAggregatesInput) SetMaxResults(v int64) *GetAssetPropertyAggregatesInput
SetMaxResults sets the MaxResults field's value.
func (s *GetAssetPropertyAggregatesInput) SetNextToken(v string) *GetAssetPropertyAggregatesInput
SetNextToken sets the NextToken field's value.
func (s *GetAssetPropertyAggregatesInput) SetPropertyAlias(v string) *GetAssetPropertyAggregatesInput
SetPropertyAlias sets the PropertyAlias field's value.
func (s *GetAssetPropertyAggregatesInput) SetPropertyId(v string) *GetAssetPropertyAggregatesInput
SetPropertyId sets the PropertyId field's value.
func (s *GetAssetPropertyAggregatesInput) SetQualities(v []*string) *GetAssetPropertyAggregatesInput
SetQualities sets the Qualities field's value.
func (s *GetAssetPropertyAggregatesInput) SetResolution(v string) *GetAssetPropertyAggregatesInput
SetResolution sets the Resolution field's value.
func (s *GetAssetPropertyAggregatesInput) SetStartDate(v time.Time) *GetAssetPropertyAggregatesInput
SetStartDate sets the StartDate field's value.
func (s *GetAssetPropertyAggregatesInput) SetTimeOrdering(v string) *GetAssetPropertyAggregatesInput
SetTimeOrdering sets the TimeOrdering field's value.
func (s GetAssetPropertyAggregatesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetAssetPropertyAggregatesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetAssetPropertyAggregatesOutput struct { // The requested aggregated values. // // AggregatedValues is a required field AggregatedValues []*AggregatedValue `locationName:"aggregatedValues" type:"list" required:"true"` // The token for the next set of results, or null if there are no additional // results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s GetAssetPropertyAggregatesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetAssetPropertyAggregatesOutput) SetAggregatedValues(v []*AggregatedValue) *GetAssetPropertyAggregatesOutput
SetAggregatedValues sets the AggregatedValues field's value.
func (s *GetAssetPropertyAggregatesOutput) SetNextToken(v string) *GetAssetPropertyAggregatesOutput
SetNextToken sets the NextToken field's value.
func (s GetAssetPropertyAggregatesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetAssetPropertyValueHistoryInput struct { // The ID of the asset. AssetId *string `location:"querystring" locationName:"assetId" min:"36" type:"string"` // The inclusive end of the range from which to query historical data, expressed // in seconds in Unix epoch time. EndDate *time.Time `location:"querystring" locationName:"endDate" type:"timestamp"` // The maximum number of results to return for each paginated request. // // Default: 100 MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token to be used for the next set of paginated results. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. PropertyAlias *string `location:"querystring" locationName:"propertyAlias" min:"1" type:"string"` // The ID of the asset property. PropertyId *string `location:"querystring" locationName:"propertyId" min:"36" type:"string"` // The quality by which to filter asset data. Qualities []*string `location:"querystring" locationName:"qualities" min:"1" type:"list" enum:"Quality"` // The exclusive start of the range from which to query historical data, expressed // in seconds in Unix epoch time. StartDate *time.Time `location:"querystring" locationName:"startDate" type:"timestamp"` // The chronological sorting order of the requested information. // // Default: ASCENDING TimeOrdering *string `location:"querystring" locationName:"timeOrdering" type:"string" enum:"TimeOrdering"` // contains filtered or unexported fields }
func (s GetAssetPropertyValueHistoryInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetAssetPropertyValueHistoryInput) SetAssetId(v string) *GetAssetPropertyValueHistoryInput
SetAssetId sets the AssetId field's value.
func (s *GetAssetPropertyValueHistoryInput) SetEndDate(v time.Time) *GetAssetPropertyValueHistoryInput
SetEndDate sets the EndDate field's value.
func (s *GetAssetPropertyValueHistoryInput) SetMaxResults(v int64) *GetAssetPropertyValueHistoryInput
SetMaxResults sets the MaxResults field's value.
func (s *GetAssetPropertyValueHistoryInput) SetNextToken(v string) *GetAssetPropertyValueHistoryInput
SetNextToken sets the NextToken field's value.
func (s *GetAssetPropertyValueHistoryInput) SetPropertyAlias(v string) *GetAssetPropertyValueHistoryInput
SetPropertyAlias sets the PropertyAlias field's value.
func (s *GetAssetPropertyValueHistoryInput) SetPropertyId(v string) *GetAssetPropertyValueHistoryInput
SetPropertyId sets the PropertyId field's value.
func (s *GetAssetPropertyValueHistoryInput) SetQualities(v []*string) *GetAssetPropertyValueHistoryInput
SetQualities sets the Qualities field's value.
func (s *GetAssetPropertyValueHistoryInput) SetStartDate(v time.Time) *GetAssetPropertyValueHistoryInput
SetStartDate sets the StartDate field's value.
func (s *GetAssetPropertyValueHistoryInput) SetTimeOrdering(v string) *GetAssetPropertyValueHistoryInput
SetTimeOrdering sets the TimeOrdering field's value.
func (s GetAssetPropertyValueHistoryInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetAssetPropertyValueHistoryInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetAssetPropertyValueHistoryOutput struct { // The asset property's value history. // // AssetPropertyValueHistory is a required field AssetPropertyValueHistory []*AssetPropertyValue `locationName:"assetPropertyValueHistory" type:"list" required:"true"` // The token for the next set of results, or null if there are no additional // results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s GetAssetPropertyValueHistoryOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetAssetPropertyValueHistoryOutput) SetAssetPropertyValueHistory(v []*AssetPropertyValue) *GetAssetPropertyValueHistoryOutput
SetAssetPropertyValueHistory sets the AssetPropertyValueHistory field's value.
func (s *GetAssetPropertyValueHistoryOutput) SetNextToken(v string) *GetAssetPropertyValueHistoryOutput
SetNextToken sets the NextToken field's value.
func (s GetAssetPropertyValueHistoryOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetAssetPropertyValueInput struct { // The ID of the asset. AssetId *string `location:"querystring" locationName:"assetId" min:"36" type:"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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. PropertyAlias *string `location:"querystring" locationName:"propertyAlias" min:"1" type:"string"` // The ID of the asset property. PropertyId *string `location:"querystring" locationName:"propertyId" min:"36" type:"string"` // contains filtered or unexported fields }
func (s GetAssetPropertyValueInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetAssetPropertyValueInput) SetAssetId(v string) *GetAssetPropertyValueInput
SetAssetId sets the AssetId field's value.
func (s *GetAssetPropertyValueInput) SetPropertyAlias(v string) *GetAssetPropertyValueInput
SetPropertyAlias sets the PropertyAlias field's value.
func (s *GetAssetPropertyValueInput) SetPropertyId(v string) *GetAssetPropertyValueInput
SetPropertyId sets the PropertyId field's value.
func (s GetAssetPropertyValueInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetAssetPropertyValueInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetAssetPropertyValueOutput struct { // The current asset property value. PropertyValue *AssetPropertyValue `locationName:"propertyValue" type:"structure"` // contains filtered or unexported fields }
func (s GetAssetPropertyValueOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetAssetPropertyValueOutput) SetPropertyValue(v *AssetPropertyValue) *GetAssetPropertyValueOutput
SetPropertyValue sets the PropertyValue field's value.
func (s GetAssetPropertyValueOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetInterpolatedAssetPropertyValuesInput struct { // The ID of the asset. AssetId *string `location:"querystring" locationName:"assetId" min:"36" type:"string"` // The inclusive end of the range from which to interpolate data, expressed // in seconds in Unix epoch time. // // EndTimeInSeconds is a required field EndTimeInSeconds *int64 `location:"querystring" locationName:"endTimeInSeconds" min:"1" type:"long" required:"true"` // The nanosecond offset converted from endTimeInSeconds. EndTimeOffsetInNanos *int64 `location:"querystring" locationName:"endTimeOffsetInNanos" type:"integer"` // The time interval in seconds over which to interpolate data. Each interval // starts when the previous one ends. // // IntervalInSeconds is a required field IntervalInSeconds *int64 `location:"querystring" locationName:"intervalInSeconds" min:"1" type:"long" required:"true"` // The query interval for the window, in seconds. IoT SiteWise computes each // interpolated value by using data points from the timestamp of each interval, // minus the window to the timestamp of each interval plus the window. If not // specified, the window ranges between the start time minus the interval and // the end time plus the interval. // // * If you specify a value for the intervalWindowInSeconds parameter, the // value for the type parameter must be LINEAR_INTERPOLATION. // // * If a data point isn't found during the specified query window, IoT SiteWise // won't return an interpolated value for the interval. This indicates that // there's a gap in the ingested data points. // // For example, you can get the interpolated temperature values for a wind turbine // every 24 hours over a duration of 7 days. If the interpolation starts on // July 1, 2021, at 9 AM with a window of 2 hours, IoT SiteWise uses the data // points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July // 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses // the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) // on July 3, 2021 to compute the second interpolated value, and so on. IntervalWindowInSeconds *int64 `location:"querystring" locationName:"intervalWindowInSeconds" min:"1" type:"long"` // The maximum number of results to return for each paginated request. If not // specified, the default value is 10. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token to be used for the next set of paginated results. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the IoT SiteWise User Guide. PropertyAlias *string `location:"querystring" locationName:"propertyAlias" min:"1" type:"string"` // The ID of the asset property. PropertyId *string `location:"querystring" locationName:"propertyId" min:"36" type:"string"` // The quality of the asset property value. You can use this parameter as a // filter to choose only the asset property values that have a specific quality. // // Quality is a required field Quality *string `location:"querystring" locationName:"quality" type:"string" required:"true" enum:"Quality"` // The exclusive start of the range from which to interpolate data, expressed // in seconds in Unix epoch time. // // StartTimeInSeconds is a required field StartTimeInSeconds *int64 `location:"querystring" locationName:"startTimeInSeconds" min:"1" type:"long" required:"true"` // The nanosecond offset converted from startTimeInSeconds. StartTimeOffsetInNanos *int64 `location:"querystring" locationName:"startTimeOffsetInNanos" type:"integer"` // The interpolation type. // // Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION // // * LINEAR_INTERPOLATION – Estimates missing data using linear interpolation // (https://en.wikipedia.org/wiki/Linear_interpolation). For example, you // can use this operation to return the interpolated temperature values for // a wind turbine every 24 hours over a duration of 7 days. If the interpolation // starts July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated // value on July 2, 2021, at 9 AM, the second interpolated value on July // 3, 2021, at 9 AM, and so on. // // * LOCF_INTERPOLATION – Estimates missing data using last observation // carried forward interpolation If no data point is found for an interval, // IoT SiteWise returns the last observed data point for the previous interval // and carries forward this interpolated value until a new data point is // found. For example, you can get the state of an on-off valve every 24 // hours over a duration of 7 days. If the interpolation starts July 1, 2021, // at 9 AM, IoT SiteWise returns the last observed data point between July // 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first interpolated value. // If a data point isn't found after 9 AM on July 2, 2021, IoT SiteWise uses // the same interpolated value for the rest of the days. // // Type is a required field Type *string `location:"querystring" locationName:"type" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s GetInterpolatedAssetPropertyValuesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetInterpolatedAssetPropertyValuesInput) SetAssetId(v string) *GetInterpolatedAssetPropertyValuesInput
SetAssetId sets the AssetId field's value.
func (s *GetInterpolatedAssetPropertyValuesInput) SetEndTimeInSeconds(v int64) *GetInterpolatedAssetPropertyValuesInput
SetEndTimeInSeconds sets the EndTimeInSeconds field's value.
func (s *GetInterpolatedAssetPropertyValuesInput) SetEndTimeOffsetInNanos(v int64) *GetInterpolatedAssetPropertyValuesInput
SetEndTimeOffsetInNanos sets the EndTimeOffsetInNanos field's value.
func (s *GetInterpolatedAssetPropertyValuesInput) SetIntervalInSeconds(v int64) *GetInterpolatedAssetPropertyValuesInput
SetIntervalInSeconds sets the IntervalInSeconds field's value.
func (s *GetInterpolatedAssetPropertyValuesInput) SetIntervalWindowInSeconds(v int64) *GetInterpolatedAssetPropertyValuesInput
SetIntervalWindowInSeconds sets the IntervalWindowInSeconds field's value.
func (s *GetInterpolatedAssetPropertyValuesInput) SetMaxResults(v int64) *GetInterpolatedAssetPropertyValuesInput
SetMaxResults sets the MaxResults field's value.
func (s *GetInterpolatedAssetPropertyValuesInput) SetNextToken(v string) *GetInterpolatedAssetPropertyValuesInput
SetNextToken sets the NextToken field's value.
func (s *GetInterpolatedAssetPropertyValuesInput) SetPropertyAlias(v string) *GetInterpolatedAssetPropertyValuesInput
SetPropertyAlias sets the PropertyAlias field's value.
func (s *GetInterpolatedAssetPropertyValuesInput) SetPropertyId(v string) *GetInterpolatedAssetPropertyValuesInput
SetPropertyId sets the PropertyId field's value.
func (s *GetInterpolatedAssetPropertyValuesInput) SetQuality(v string) *GetInterpolatedAssetPropertyValuesInput
SetQuality sets the Quality field's value.
func (s *GetInterpolatedAssetPropertyValuesInput) SetStartTimeInSeconds(v int64) *GetInterpolatedAssetPropertyValuesInput
SetStartTimeInSeconds sets the StartTimeInSeconds field's value.
func (s *GetInterpolatedAssetPropertyValuesInput) SetStartTimeOffsetInNanos(v int64) *GetInterpolatedAssetPropertyValuesInput
SetStartTimeOffsetInNanos sets the StartTimeOffsetInNanos field's value.
func (s *GetInterpolatedAssetPropertyValuesInput) SetType(v string) *GetInterpolatedAssetPropertyValuesInput
SetType sets the Type field's value.
func (s GetInterpolatedAssetPropertyValuesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetInterpolatedAssetPropertyValuesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetInterpolatedAssetPropertyValuesOutput struct { // The requested interpolated values. // // InterpolatedAssetPropertyValues is a required field InterpolatedAssetPropertyValues []*InterpolatedAssetPropertyValue `locationName:"interpolatedAssetPropertyValues" type:"list" required:"true"` // The token for the next set of results, or null if there are no additional // results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (s GetInterpolatedAssetPropertyValuesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetInterpolatedAssetPropertyValuesOutput) SetInterpolatedAssetPropertyValues(v []*InterpolatedAssetPropertyValue) *GetInterpolatedAssetPropertyValuesOutput
SetInterpolatedAssetPropertyValues sets the InterpolatedAssetPropertyValues field's value.
func (s *GetInterpolatedAssetPropertyValuesOutput) SetNextToken(v string) *GetInterpolatedAssetPropertyValuesOutput
SetNextToken sets the NextToken field's value.
func (s GetInterpolatedAssetPropertyValuesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 IoT Greengrass API Reference. // // GroupArn is a required field GroupArn *string `locationName:"groupArn" min:"1" type:"string" required:"true"` // 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 gateway (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html) in the IoT SiteWise User Guide.
func (s Greengrass) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Greengrass) SetGroupArn(v string) *Greengrass
SetGroupArn sets the GroupArn field's value.
func (s Greengrass) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Greengrass) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GreengrassV2 struct { // The name of the IoT thing for your IoT Greengrass V2 core device. // // CoreDeviceThingName is a required field CoreDeviceThingName *string `locationName:"coreDeviceThingName" min:"1" type:"string" required:"true"` // 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 role (https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html) must use the AWSIoTSiteWiseEdgeAccess policy. For more information, see Using IoT SiteWise at the edge (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html) in the IoT SiteWise User Guide.
func (s GreengrassV2) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GreengrassV2) SetCoreDeviceThingName(v string) *GreengrassV2
SetCoreDeviceThingName sets the CoreDeviceThingName field's value.
func (s GreengrassV2) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GreengrassV2) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GroupIdentity struct { // The Amazon Web Services SSO ID of the group. // // Id is a required field Id *string `locationName:"id" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains information for a group identity in an access policy.
func (s GroupIdentity) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GroupIdentity) SetId(v string) *GroupIdentity
SetId sets the Id field's value.
func (s GroupIdentity) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GroupIdentity) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type IAMRoleIdentity struct { // The ARN of the IAM role. For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) // in the IAM User Guide. // // Arn is a required field Arn *string `locationName:"arn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains information about an Identity and Access Management role. For more information, see IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the IAM User Guide.
func (s IAMRoleIdentity) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *IAMRoleIdentity) SetArn(v string) *IAMRoleIdentity
SetArn sets the Arn field's value.
func (s IAMRoleIdentity) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *IAMRoleIdentity) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type IAMUserIdentity struct { // The ARN of the IAM user. 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. // // Arn is a required field Arn *string `locationName:"arn" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains information about an Identity and Access Management user.
func (s IAMUserIdentity) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *IAMUserIdentity) SetArn(v string) *IAMUserIdentity
SetArn sets the Arn field's value.
func (s IAMUserIdentity) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *IAMUserIdentity) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Identity struct { // An Amazon Web Services SSO group identity. Group *GroupIdentity `locationName:"group" type:"structure"` // An IAM role identity. IamRole *IAMRoleIdentity `locationName:"iamRole" type:"structure"` // An IAM user identity. IamUser *IAMUserIdentity `locationName:"iamUser" type:"structure"` // An Amazon Web Services SSO user identity. User *UserIdentity `locationName:"user" type:"structure"` // contains filtered or unexported fields }
Contains an identity that can access an IoT SiteWise Monitor resource.
Currently, you can't use Amazon Web Services APIs to retrieve Amazon Web Services SSO identity IDs. You can find the Amazon Web Services SSO identity IDs in the URL of user and group pages in the Amazon Web Services SSO console (https://console.aws.amazon.com/singlesignon).
func (s Identity) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Identity) SetGroup(v *GroupIdentity) *Identity
SetGroup sets the Group field's value.
func (s *Identity) SetIamRole(v *IAMRoleIdentity) *Identity
SetIamRole sets the IamRole field's value.
func (s *Identity) SetIamUser(v *IAMUserIdentity) *Identity
SetIamUser sets the IamUser field's value.
func (s *Identity) SetUser(v *UserIdentity) *Identity
SetUser sets the User field's value.
func (s Identity) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Identity) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Image struct { // Contains an image file. File *ImageFile `locationName:"file" type:"structure"` // The ID of an existing image. Specify this parameter to keep an existing image. Id *string `locationName:"id" min:"36" type:"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.
func (s Image) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Image) SetFile(v *ImageFile) *Image
SetFile sets the File field's value.
func (s *Image) SetId(v string) *Image
SetId sets the Id field's value.
func (s Image) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Image) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ImageFile struct { // The image file contents, represented as a base64-encoded string. The file // size must be less than 1 MB. // Data is automatically base64 encoded/decoded by the SDK. // // Data is a required field Data []byte `locationName:"data" min:"1" type:"blob" required:"true"` // The file type of the image. // // Type is a required field Type *string `locationName:"type" type:"string" required:"true" enum:"ImageFileType"` // contains filtered or unexported fields }
Contains an image file.
func (s ImageFile) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ImageFile) SetData(v []byte) *ImageFile
SetData sets the Data field's value.
func (s *ImageFile) SetType(v string) *ImageFile
SetType sets the Type field's value.
func (s ImageFile) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ImageFile) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ImageLocation struct { // The ID of the image. // // Id is a required field Id *string `locationName:"id" min:"36" type:"string" required:"true"` // The URL where the image is available. The URL is valid for 15 minutes so // that you can view and download the image // // Url is a required field Url *string `locationName:"url" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains an image that is uploaded to IoT SiteWise and available at a URL.
func (s ImageLocation) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ImageLocation) SetId(v string) *ImageLocation
SetId sets the Id field's value.
func (s *ImageLocation) SetUrl(v string) *ImageLocation
SetUrl sets the Url field's value.
func (s ImageLocation) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InternalFailureException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
IoT SiteWise can't process your request right now. Try again later.
func (s *InternalFailureException) Code() string
Code returns the exception type name.
func (s *InternalFailureException) Error() string
func (s InternalFailureException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InternalFailureException) Message() string
Message returns the exception's message.
func (s *InternalFailureException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InternalFailureException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InternalFailureException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InternalFailureException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InterpolatedAssetPropertyValue struct { // Contains a timestamp with optional nanosecond granularity. // // Timestamp is a required field Timestamp *TimeInNanos `locationName:"timestamp" type:"structure" required:"true"` // Contains an asset property value (of a single type only). // // Value is a required field Value *Variant `locationName:"value" type:"structure" required:"true"` // contains filtered or unexported fields }
Contains information about an interpolated asset property value.
func (s InterpolatedAssetPropertyValue) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InterpolatedAssetPropertyValue) SetTimestamp(v *TimeInNanos) *InterpolatedAssetPropertyValue
SetTimestamp sets the Timestamp field's value.
func (s *InterpolatedAssetPropertyValue) SetValue(v *Variant) *InterpolatedAssetPropertyValue
SetValue sets the Value field's value.
func (s InterpolatedAssetPropertyValue) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InvalidRequestException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"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 (s *InvalidRequestException) Code() string
Code returns the exception type name.
func (s *InvalidRequestException) Error() string
func (s InvalidRequestException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InvalidRequestException) Message() string
Message returns the exception's message.
func (s *InvalidRequestException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidRequestException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidRequestException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidRequestException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type IoTSiteWise struct { *client.Client }
IoTSiteWise provides the API operation methods for making requests to AWS IoT SiteWise. See this package's package overview docs for details on the service.
IoTSiteWise methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New(p client.ConfigProvider, cfgs ...*aws.Config) *IoTSiteWise
New creates a new instance of the IoTSiteWise client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession()) // Create a IoTSiteWise client from just a session. svc := iotsitewise.New(mySession) // Create a IoTSiteWise client with additional configuration svc := iotsitewise.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (c *IoTSiteWise) AssociateAssets(input *AssociateAssetsInput) (*AssociateAssetsOutput, error)
AssociateAssets API operation for AWS IoT SiteWise.
Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html) in the IoT SiteWise User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation AssociateAssets for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * LimitExceededException 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 IoT SiteWise User Guide. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide. * ConflictingOperationException 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/AssociateAssets
func (c *IoTSiteWise) AssociateAssetsRequest(input *AssociateAssetsInput) (req *request.Request, output *AssociateAssetsOutput)
AssociateAssetsRequest generates a "aws/request.Request" representing the client's request for the AssociateAssets operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See AssociateAssets for more information on using the AssociateAssets API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the AssociateAssetsRequest method. req, resp := client.AssociateAssetsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/AssociateAssets
func (c *IoTSiteWise) AssociateAssetsWithContext(ctx aws.Context, input *AssociateAssetsInput, opts ...request.Option) (*AssociateAssetsOutput, error)
AssociateAssetsWithContext is the same as AssociateAssets with the addition of the ability to pass a context and additional request options.
See AssociateAssets for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) AssociateTimeSeriesToAssetProperty(input *AssociateTimeSeriesToAssetPropertyInput) (*AssociateTimeSeriesToAssetPropertyOutput, error)
AssociateTimeSeriesToAssetProperty API operation for AWS IoT SiteWise.
Associates a time series (data stream) with an asset property.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation AssociateTimeSeriesToAssetProperty for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide. * ConflictingOperationException 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/AssociateTimeSeriesToAssetProperty
func (c *IoTSiteWise) AssociateTimeSeriesToAssetPropertyRequest(input *AssociateTimeSeriesToAssetPropertyInput) (req *request.Request, output *AssociateTimeSeriesToAssetPropertyOutput)
AssociateTimeSeriesToAssetPropertyRequest generates a "aws/request.Request" representing the client's request for the AssociateTimeSeriesToAssetProperty operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See AssociateTimeSeriesToAssetProperty for more information on using the AssociateTimeSeriesToAssetProperty API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the AssociateTimeSeriesToAssetPropertyRequest method. req, resp := client.AssociateTimeSeriesToAssetPropertyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/AssociateTimeSeriesToAssetProperty
func (c *IoTSiteWise) AssociateTimeSeriesToAssetPropertyWithContext(ctx aws.Context, input *AssociateTimeSeriesToAssetPropertyInput, opts ...request.Option) (*AssociateTimeSeriesToAssetPropertyOutput, error)
AssociateTimeSeriesToAssetPropertyWithContext is the same as AssociateTimeSeriesToAssetProperty with the addition of the ability to pass a context and additional request options.
See AssociateTimeSeriesToAssetProperty for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) BatchAssociateProjectAssets(input *BatchAssociateProjectAssetsInput) (*BatchAssociateProjectAssetsOutput, error)
BatchAssociateProjectAssets API operation for AWS IoT SiteWise.
Associates a group (batch) of assets with an IoT SiteWise Monitor project.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation BatchAssociateProjectAssets for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide. * LimitExceededException 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 IoT SiteWise User Guide.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchAssociateProjectAssets
func (c *IoTSiteWise) BatchAssociateProjectAssetsRequest(input *BatchAssociateProjectAssetsInput) (req *request.Request, output *BatchAssociateProjectAssetsOutput)
BatchAssociateProjectAssetsRequest generates a "aws/request.Request" representing the client's request for the BatchAssociateProjectAssets operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See BatchAssociateProjectAssets for more information on using the BatchAssociateProjectAssets API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the BatchAssociateProjectAssetsRequest method. req, resp := client.BatchAssociateProjectAssetsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchAssociateProjectAssets
func (c *IoTSiteWise) BatchAssociateProjectAssetsWithContext(ctx aws.Context, input *BatchAssociateProjectAssetsInput, opts ...request.Option) (*BatchAssociateProjectAssetsOutput, error)
BatchAssociateProjectAssetsWithContext is the same as BatchAssociateProjectAssets with the addition of the ability to pass a context and additional request options.
See BatchAssociateProjectAssets for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) BatchDisassociateProjectAssets(input *BatchDisassociateProjectAssetsInput) (*BatchDisassociateProjectAssetsOutput, error)
BatchDisassociateProjectAssets API operation for AWS IoT SiteWise.
Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation BatchDisassociateProjectAssets for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchDisassociateProjectAssets
func (c *IoTSiteWise) BatchDisassociateProjectAssetsRequest(input *BatchDisassociateProjectAssetsInput) (req *request.Request, output *BatchDisassociateProjectAssetsOutput)
BatchDisassociateProjectAssetsRequest generates a "aws/request.Request" representing the client's request for the BatchDisassociateProjectAssets operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See BatchDisassociateProjectAssets for more information on using the BatchDisassociateProjectAssets API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the BatchDisassociateProjectAssetsRequest method. req, resp := client.BatchDisassociateProjectAssetsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchDisassociateProjectAssets
func (c *IoTSiteWise) BatchDisassociateProjectAssetsWithContext(ctx aws.Context, input *BatchDisassociateProjectAssetsInput, opts ...request.Option) (*BatchDisassociateProjectAssetsOutput, error)
BatchDisassociateProjectAssetsWithContext is the same as BatchDisassociateProjectAssets with the addition of the ability to pass a context and additional request options.
See BatchDisassociateProjectAssets for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) BatchGetAssetPropertyAggregates(input *BatchGetAssetPropertyAggregatesInput) (*BatchGetAssetPropertyAggregatesOutput, error)
BatchGetAssetPropertyAggregates API operation for AWS IoT SiteWise.
Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see Querying aggregates (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates) in the IoT SiteWise User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation BatchGetAssetPropertyAggregates for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide. * ServiceUnavailableException The requested service is unavailable.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregates
func (c *IoTSiteWise) BatchGetAssetPropertyAggregatesPages(input *BatchGetAssetPropertyAggregatesInput, fn func(*BatchGetAssetPropertyAggregatesOutput, bool) bool) error
BatchGetAssetPropertyAggregatesPages iterates over the pages of a BatchGetAssetPropertyAggregates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See BatchGetAssetPropertyAggregates method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a BatchGetAssetPropertyAggregates operation. pageNum := 0 err := client.BatchGetAssetPropertyAggregatesPages(params, func(page *iotsitewise.BatchGetAssetPropertyAggregatesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *IoTSiteWise) BatchGetAssetPropertyAggregatesPagesWithContext(ctx aws.Context, input *BatchGetAssetPropertyAggregatesInput, fn func(*BatchGetAssetPropertyAggregatesOutput, bool) bool, opts ...request.Option) error
BatchGetAssetPropertyAggregatesPagesWithContext same as BatchGetAssetPropertyAggregatesPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) BatchGetAssetPropertyAggregatesRequest(input *BatchGetAssetPropertyAggregatesInput) (req *request.Request, output *BatchGetAssetPropertyAggregatesOutput)
BatchGetAssetPropertyAggregatesRequest generates a "aws/request.Request" representing the client's request for the BatchGetAssetPropertyAggregates operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See BatchGetAssetPropertyAggregates for more information on using the BatchGetAssetPropertyAggregates API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the BatchGetAssetPropertyAggregatesRequest method. req, resp := client.BatchGetAssetPropertyAggregatesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregates
func (c *IoTSiteWise) BatchGetAssetPropertyAggregatesWithContext(ctx aws.Context, input *BatchGetAssetPropertyAggregatesInput, opts ...request.Option) (*BatchGetAssetPropertyAggregatesOutput, error)
BatchGetAssetPropertyAggregatesWithContext is the same as BatchGetAssetPropertyAggregates with the addition of the ability to pass a context and additional request options.
See BatchGetAssetPropertyAggregates for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) BatchGetAssetPropertyValue(input *BatchGetAssetPropertyValueInput) (*BatchGetAssetPropertyValueOutput, error)
BatchGetAssetPropertyValue API operation for AWS IoT SiteWise.
Gets the current value for one or more asset properties. For more information, see Querying current values (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values) in the IoT SiteWise User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation BatchGetAssetPropertyValue for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide. * ServiceUnavailableException The requested service is unavailable.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchGetAssetPropertyValue
func (c *IoTSiteWise) BatchGetAssetPropertyValueHistory(input *BatchGetAssetPropertyValueHistoryInput) (*BatchGetAssetPropertyValueHistoryOutput, error)
BatchGetAssetPropertyValueHistory API operation for AWS IoT SiteWise.
Gets the historical values for one or more asset properties. For more information, see Querying historical values (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values) in the IoT SiteWise User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation BatchGetAssetPropertyValueHistory for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide. * ServiceUnavailableException The requested service is unavailable.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistory
func (c *IoTSiteWise) BatchGetAssetPropertyValueHistoryPages(input *BatchGetAssetPropertyValueHistoryInput, fn func(*BatchGetAssetPropertyValueHistoryOutput, bool) bool) error
BatchGetAssetPropertyValueHistoryPages iterates over the pages of a BatchGetAssetPropertyValueHistory operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See BatchGetAssetPropertyValueHistory method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a BatchGetAssetPropertyValueHistory operation. pageNum := 0 err := client.BatchGetAssetPropertyValueHistoryPages(params, func(page *iotsitewise.BatchGetAssetPropertyValueHistoryOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *IoTSiteWise) BatchGetAssetPropertyValueHistoryPagesWithContext(ctx aws.Context, input *BatchGetAssetPropertyValueHistoryInput, fn func(*BatchGetAssetPropertyValueHistoryOutput, bool) bool, opts ...request.Option) error
BatchGetAssetPropertyValueHistoryPagesWithContext same as BatchGetAssetPropertyValueHistoryPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) BatchGetAssetPropertyValueHistoryRequest(input *BatchGetAssetPropertyValueHistoryInput) (req *request.Request, output *BatchGetAssetPropertyValueHistoryOutput)
BatchGetAssetPropertyValueHistoryRequest generates a "aws/request.Request" representing the client's request for the BatchGetAssetPropertyValueHistory operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See BatchGetAssetPropertyValueHistory for more information on using the BatchGetAssetPropertyValueHistory API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the BatchGetAssetPropertyValueHistoryRequest method. req, resp := client.BatchGetAssetPropertyValueHistoryRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistory
func (c *IoTSiteWise) BatchGetAssetPropertyValueHistoryWithContext(ctx aws.Context, input *BatchGetAssetPropertyValueHistoryInput, opts ...request.Option) (*BatchGetAssetPropertyValueHistoryOutput, error)
BatchGetAssetPropertyValueHistoryWithContext is the same as BatchGetAssetPropertyValueHistory with the addition of the ability to pass a context and additional request options.
See BatchGetAssetPropertyValueHistory for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) BatchGetAssetPropertyValuePages(input *BatchGetAssetPropertyValueInput, fn func(*BatchGetAssetPropertyValueOutput, bool) bool) error
BatchGetAssetPropertyValuePages iterates over the pages of a BatchGetAssetPropertyValue operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See BatchGetAssetPropertyValue method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a BatchGetAssetPropertyValue operation. pageNum := 0 err := client.BatchGetAssetPropertyValuePages(params, func(page *iotsitewise.BatchGetAssetPropertyValueOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *IoTSiteWise) BatchGetAssetPropertyValuePagesWithContext(ctx aws.Context, input *BatchGetAssetPropertyValueInput, fn func(*BatchGetAssetPropertyValueOutput, bool) bool, opts ...request.Option) error
BatchGetAssetPropertyValuePagesWithContext same as BatchGetAssetPropertyValuePages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) BatchGetAssetPropertyValueRequest(input *BatchGetAssetPropertyValueInput) (req *request.Request, output *BatchGetAssetPropertyValueOutput)
BatchGetAssetPropertyValueRequest generates a "aws/request.Request" representing the client's request for the BatchGetAssetPropertyValue operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See BatchGetAssetPropertyValue for more information on using the BatchGetAssetPropertyValue API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the BatchGetAssetPropertyValueRequest method. req, resp := client.BatchGetAssetPropertyValueRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchGetAssetPropertyValue
func (c *IoTSiteWise) BatchGetAssetPropertyValueWithContext(ctx aws.Context, input *BatchGetAssetPropertyValueInput, opts ...request.Option) (*BatchGetAssetPropertyValueOutput, error)
BatchGetAssetPropertyValueWithContext is the same as BatchGetAssetPropertyValue with the addition of the ability to pass a context and additional request options.
See BatchGetAssetPropertyValue for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) BatchPutAssetPropertyValue(input *BatchPutAssetPropertyValueInput) (*BatchPutAssetPropertyValueOutput, error)
BatchPutAssetPropertyValue API operation for AWS IoT SiteWise.
Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html) in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
* The assetId and propertyId of an asset property. * A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html).
With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error.
For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV.
IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-batchputassetpropertyvalue-action) in the IoT SiteWise User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation BatchPutAssetPropertyValue for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide. * LimitExceededException 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 IoT SiteWise User Guide. * ServiceUnavailableException The requested service is unavailable. * ConflictingOperationException 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchPutAssetPropertyValue
func (c *IoTSiteWise) BatchPutAssetPropertyValueRequest(input *BatchPutAssetPropertyValueInput) (req *request.Request, output *BatchPutAssetPropertyValueOutput)
BatchPutAssetPropertyValueRequest generates a "aws/request.Request" representing the client's request for the BatchPutAssetPropertyValue operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See BatchPutAssetPropertyValue for more information on using the BatchPutAssetPropertyValue API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the BatchPutAssetPropertyValueRequest method. req, resp := client.BatchPutAssetPropertyValueRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchPutAssetPropertyValue
func (c *IoTSiteWise) BatchPutAssetPropertyValueWithContext(ctx aws.Context, input *BatchPutAssetPropertyValueInput, opts ...request.Option) (*BatchPutAssetPropertyValueOutput, error)
BatchPutAssetPropertyValueWithContext is the same as BatchPutAssetPropertyValue with the addition of the ability to pass a context and additional request options.
See BatchPutAssetPropertyValue for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) CreateAccessPolicy(input *CreateAccessPolicyInput) (*CreateAccessPolicyOutput, error)
CreateAccessPolicy API operation for AWS IoT SiteWise.
Creates an access policy that grants the specified identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation CreateAccessPolicy for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide. * LimitExceededException 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 IoT SiteWise User Guide.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateAccessPolicy
func (c *IoTSiteWise) CreateAccessPolicyRequest(input *CreateAccessPolicyInput) (req *request.Request, output *CreateAccessPolicyOutput)
CreateAccessPolicyRequest generates a "aws/request.Request" representing the client's request for the CreateAccessPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateAccessPolicy for more information on using the CreateAccessPolicy API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateAccessPolicyRequest method. req, resp := client.CreateAccessPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateAccessPolicy
func (c *IoTSiteWise) CreateAccessPolicyWithContext(ctx aws.Context, input *CreateAccessPolicyInput, opts ...request.Option) (*CreateAccessPolicyOutput, error)
CreateAccessPolicyWithContext is the same as CreateAccessPolicy with the addition of the ability to pass a context and additional request options.
See CreateAccessPolicy for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) CreateAsset(input *CreateAssetInput) (*CreateAssetOutput, error)
CreateAsset API operation for AWS IoT SiteWise.
Creates an asset from an existing asset model. For more information, see Creating assets (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html) in the IoT SiteWise User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation CreateAsset for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceAlreadyExistsException The resource already exists. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide. * LimitExceededException 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 IoT SiteWise User Guide. * ConflictingOperationException 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateAsset
func (c *IoTSiteWise) CreateAssetModel(input *CreateAssetModelInput) (*CreateAssetModelOutput, error)
CreateAssetModel API operation for AWS IoT SiteWise.
Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html) in the IoT SiteWise User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation CreateAssetModel for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceAlreadyExistsException The resource already exists. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide. * LimitExceededException 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 IoT SiteWise User Guide. * ConflictingOperationException 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateAssetModel
func (c *IoTSiteWise) CreateAssetModelRequest(input *CreateAssetModelInput) (req *request.Request, output *CreateAssetModelOutput)
CreateAssetModelRequest generates a "aws/request.Request" representing the client's request for the CreateAssetModel operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateAssetModel for more information on using the CreateAssetModel API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateAssetModelRequest method. req, resp := client.CreateAssetModelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateAssetModel
func (c *IoTSiteWise) CreateAssetModelWithContext(ctx aws.Context, input *CreateAssetModelInput, opts ...request.Option) (*CreateAssetModelOutput, error)
CreateAssetModelWithContext is the same as CreateAssetModel with the addition of the ability to pass a context and additional request options.
See CreateAssetModel for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) CreateAssetRequest(input *CreateAssetInput) (req *request.Request, output *CreateAssetOutput)
CreateAssetRequest generates a "aws/request.Request" representing the client's request for the CreateAsset operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateAsset for more information on using the CreateAsset API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateAssetRequest method. req, resp := client.CreateAssetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateAsset
func (c *IoTSiteWise) CreateAssetWithContext(ctx aws.Context, input *CreateAssetInput, opts ...request.Option) (*CreateAssetOutput, error)
CreateAssetWithContext is the same as CreateAsset with the addition of the ability to pass a context and additional request options.
See CreateAsset for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) CreateDashboard(input *CreateDashboardInput) (*CreateDashboardOutput, error)
CreateDashboard API operation for AWS IoT SiteWise.
Creates a dashboard in an IoT SiteWise Monitor project.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation CreateDashboard for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide. * LimitExceededException 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 IoT SiteWise User Guide.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateDashboard
func (c *IoTSiteWise) CreateDashboardRequest(input *CreateDashboardInput) (req *request.Request, output *CreateDashboardOutput)
CreateDashboardRequest generates a "aws/request.Request" representing the client's request for the CreateDashboard operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateDashboard for more information on using the CreateDashboard API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateDashboardRequest method. req, resp := client.CreateDashboardRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateDashboard
func (c *IoTSiteWise) CreateDashboardWithContext(ctx aws.Context, input *CreateDashboardInput, opts ...request.Option) (*CreateDashboardOutput, error)
CreateDashboardWithContext is the same as CreateDashboard with the addition of the ability to pass a context and additional request options.
See CreateDashboard for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) CreateGateway(input *CreateGatewayInput) (*CreateGatewayOutput, error)
CreateGateway API operation for AWS IoT SiteWise.
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to 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 IoT SiteWise User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation CreateGateway for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceAlreadyExistsException The resource already exists. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide. * LimitExceededException 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 IoT SiteWise User Guide.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateGateway
func (c *IoTSiteWise) CreateGatewayRequest(input *CreateGatewayInput) (req *request.Request, output *CreateGatewayOutput)
CreateGatewayRequest generates a "aws/request.Request" representing the client's request for the CreateGateway operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateGateway for more information on using the CreateGateway API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateGatewayRequest method. req, resp := client.CreateGatewayRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateGateway
func (c *IoTSiteWise) CreateGatewayWithContext(ctx aws.Context, input *CreateGatewayInput, opts ...request.Option) (*CreateGatewayOutput, error)
CreateGatewayWithContext is the same as CreateGateway with the addition of the ability to pass a context and additional request options.
See CreateGateway for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) CreatePortal(input *CreatePortalInput) (*CreatePortalOutput, error)
CreatePortal API operation for AWS IoT SiteWise.
Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses Amazon Web Services SSO or IAM to authenticate portal users and manage user permissions.
Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) in the IoT SiteWise User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation CreatePortal for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide. * LimitExceededException 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 IoT SiteWise User Guide.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreatePortal
func (c *IoTSiteWise) CreatePortalRequest(input *CreatePortalInput) (req *request.Request, output *CreatePortalOutput)
CreatePortalRequest generates a "aws/request.Request" representing the client's request for the CreatePortal operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreatePortal for more information on using the CreatePortal API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreatePortalRequest method. req, resp := client.CreatePortalRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreatePortal
func (c *IoTSiteWise) CreatePortalWithContext(ctx aws.Context, input *CreatePortalInput, opts ...request.Option) (*CreatePortalOutput, error)
CreatePortalWithContext is the same as CreatePortal with the addition of the ability to pass a context and additional request options.
See CreatePortal for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) CreateProject(input *CreateProjectInput) (*CreateProjectOutput, error)
CreateProject API operation for AWS IoT SiteWise.
Creates a project in the specified portal.
Make sure that the project name and description don't contain confidential information.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation CreateProject for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide. * LimitExceededException 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 IoT SiteWise User Guide.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateProject
func (c *IoTSiteWise) CreateProjectRequest(input *CreateProjectInput) (req *request.Request, output *CreateProjectOutput)
CreateProjectRequest generates a "aws/request.Request" representing the client's request for the CreateProject operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateProject for more information on using the CreateProject API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateProjectRequest method. req, resp := client.CreateProjectRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateProject
func (c *IoTSiteWise) CreateProjectWithContext(ctx aws.Context, input *CreateProjectInput, opts ...request.Option) (*CreateProjectOutput, error)
CreateProjectWithContext is the same as CreateProject with the addition of the ability to pass a context and additional request options.
See CreateProject for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) DeleteAccessPolicy(input *DeleteAccessPolicyInput) (*DeleteAccessPolicyOutput, error)
DeleteAccessPolicy API operation for AWS IoT SiteWise.
Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation DeleteAccessPolicy for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteAccessPolicy
func (c *IoTSiteWise) DeleteAccessPolicyRequest(input *DeleteAccessPolicyInput) (req *request.Request, output *DeleteAccessPolicyOutput)
DeleteAccessPolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteAccessPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteAccessPolicy for more information on using the DeleteAccessPolicy API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteAccessPolicyRequest method. req, resp := client.DeleteAccessPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteAccessPolicy
func (c *IoTSiteWise) DeleteAccessPolicyWithContext(ctx aws.Context, input *DeleteAccessPolicyInput, opts ...request.Option) (*DeleteAccessPolicyOutput, error)
DeleteAccessPolicyWithContext is the same as DeleteAccessPolicy with the addition of the ability to pass a context and additional request options.
See DeleteAccessPolicy for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) DeleteAsset(input *DeleteAssetInput) (*DeleteAssetOutput, error)
DeleteAsset API operation for AWS IoT SiteWise.
Deletes an asset. This action can't be undone. For more information, see Deleting assets and models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html) in the IoT SiteWise User Guide.
You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DisassociateAssets.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation DeleteAsset for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide. * ConflictingOperationException 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteAsset
func (c *IoTSiteWise) DeleteAssetModel(input *DeleteAssetModelInput) (*DeleteAssetModelOutput, error)
DeleteAssetModel API operation for AWS IoT SiteWise.
Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html) in the IoT SiteWise User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation DeleteAssetModel for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide. * ConflictingOperationException 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteAssetModel
func (c *IoTSiteWise) DeleteAssetModelRequest(input *DeleteAssetModelInput) (req *request.Request, output *DeleteAssetModelOutput)
DeleteAssetModelRequest generates a "aws/request.Request" representing the client's request for the DeleteAssetModel operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteAssetModel for more information on using the DeleteAssetModel API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteAssetModelRequest method. req, resp := client.DeleteAssetModelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteAssetModel
func (c *IoTSiteWise) DeleteAssetModelWithContext(ctx aws.Context, input *DeleteAssetModelInput, opts ...request.Option) (*DeleteAssetModelOutput, error)
DeleteAssetModelWithContext is the same as DeleteAssetModel with the addition of the ability to pass a context and additional request options.
See DeleteAssetModel for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) DeleteAssetRequest(input *DeleteAssetInput) (req *request.Request, output *DeleteAssetOutput)
DeleteAssetRequest generates a "aws/request.Request" representing the client's request for the DeleteAsset operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteAsset for more information on using the DeleteAsset API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteAssetRequest method. req, resp := client.DeleteAssetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteAsset
func (c *IoTSiteWise) DeleteAssetWithContext(ctx aws.Context, input *DeleteAssetInput, opts ...request.Option) (*DeleteAssetOutput, error)
DeleteAssetWithContext is the same as DeleteAsset with the addition of the ability to pass a context and additional request options.
See DeleteAsset for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) DeleteDashboard(input *DeleteDashboardInput) (*DeleteDashboardOutput, error)
DeleteDashboard API operation for AWS IoT SiteWise.
Deletes a dashboard from IoT SiteWise Monitor.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation DeleteDashboard for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteDashboard
func (c *IoTSiteWise) DeleteDashboardRequest(input *DeleteDashboardInput) (req *request.Request, output *DeleteDashboardOutput)
DeleteDashboardRequest generates a "aws/request.Request" representing the client's request for the DeleteDashboard operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteDashboard for more information on using the DeleteDashboard API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteDashboardRequest method. req, resp := client.DeleteDashboardRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteDashboard
func (c *IoTSiteWise) DeleteDashboardWithContext(ctx aws.Context, input *DeleteDashboardInput, opts ...request.Option) (*DeleteDashboardOutput, error)
DeleteDashboardWithContext is the same as DeleteDashboard with the addition of the ability to pass a context and additional request options.
See DeleteDashboard for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) DeleteGateway(input *DeleteGatewayInput) (*DeleteGatewayOutput, error)
DeleteGateway API operation for AWS IoT SiteWise.
Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation DeleteGateway for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteGateway
func (c *IoTSiteWise) DeleteGatewayRequest(input *DeleteGatewayInput) (req *request.Request, output *DeleteGatewayOutput)
DeleteGatewayRequest generates a "aws/request.Request" representing the client's request for the DeleteGateway operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteGateway for more information on using the DeleteGateway API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteGatewayRequest method. req, resp := client.DeleteGatewayRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteGateway
func (c *IoTSiteWise) DeleteGatewayWithContext(ctx aws.Context, input *DeleteGatewayInput, opts ...request.Option) (*DeleteGatewayOutput, error)
DeleteGatewayWithContext is the same as DeleteGateway with the addition of the ability to pass a context and additional request options.
See DeleteGateway for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) DeletePortal(input *DeletePortalInput) (*DeletePortalOutput, error)
DeletePortal API operation for AWS IoT SiteWise.
Deletes a portal from IoT SiteWise Monitor.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation DeletePortal for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide. * ConflictingOperationException 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeletePortal
func (c *IoTSiteWise) DeletePortalRequest(input *DeletePortalInput) (req *request.Request, output *DeletePortalOutput)
DeletePortalRequest generates a "aws/request.Request" representing the client's request for the DeletePortal operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeletePortal for more information on using the DeletePortal API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeletePortalRequest method. req, resp := client.DeletePortalRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeletePortal
func (c *IoTSiteWise) DeletePortalWithContext(ctx aws.Context, input *DeletePortalInput, opts ...request.Option) (*DeletePortalOutput, error)
DeletePortalWithContext is the same as DeletePortal with the addition of the ability to pass a context and additional request options.
See DeletePortal for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) DeleteProject(input *DeleteProjectInput) (*DeleteProjectOutput, error)
DeleteProject API operation for AWS IoT SiteWise.
Deletes a project from IoT SiteWise Monitor.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation DeleteProject for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteProject
func (c *IoTSiteWise) DeleteProjectRequest(input *DeleteProjectInput) (req *request.Request, output *DeleteProjectOutput)
DeleteProjectRequest generates a "aws/request.Request" representing the client's request for the DeleteProject operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteProject for more information on using the DeleteProject API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteProjectRequest method. req, resp := client.DeleteProjectRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteProject
func (c *IoTSiteWise) DeleteProjectWithContext(ctx aws.Context, input *DeleteProjectInput, opts ...request.Option) (*DeleteProjectOutput, error)
DeleteProjectWithContext is the same as DeleteProject with the addition of the ability to pass a context and additional request options.
See DeleteProject for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) DeleteTimeSeries(input *DeleteTimeSeriesInput) (*DeleteTimeSeriesOutput, error)
DeleteTimeSeries API operation for AWS IoT SiteWise.
Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.
To identify a time series, do one of the following:
* If the time series isn't associated with an asset property, specify the alias of the time series. * If the time series is associated with an asset property, specify one of the following: The alias of the time series. The assetId and propertyId that identifies the asset property.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation DeleteTimeSeries for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide. * ConflictingOperationException 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteTimeSeries
func (c *IoTSiteWise) DeleteTimeSeriesRequest(input *DeleteTimeSeriesInput) (req *request.Request, output *DeleteTimeSeriesOutput)
DeleteTimeSeriesRequest generates a "aws/request.Request" representing the client's request for the DeleteTimeSeries operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteTimeSeries for more information on using the DeleteTimeSeries API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteTimeSeriesRequest method. req, resp := client.DeleteTimeSeriesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteTimeSeries
func (c *IoTSiteWise) DeleteTimeSeriesWithContext(ctx aws.Context, input *DeleteTimeSeriesInput, opts ...request.Option) (*DeleteTimeSeriesOutput, error)
DeleteTimeSeriesWithContext is the same as DeleteTimeSeries with the addition of the ability to pass a context and additional request options.
See DeleteTimeSeries for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) DescribeAccessPolicy(input *DescribeAccessPolicyInput) (*DescribeAccessPolicyOutput, error)
DescribeAccessPolicy API operation for AWS IoT SiteWise.
Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeAccessPolicy for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAccessPolicy
func (c *IoTSiteWise) DescribeAccessPolicyRequest(input *DescribeAccessPolicyInput) (req *request.Request, output *DescribeAccessPolicyOutput)
DescribeAccessPolicyRequest generates a "aws/request.Request" representing the client's request for the DescribeAccessPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeAccessPolicy for more information on using the DescribeAccessPolicy API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeAccessPolicyRequest method. req, resp := client.DescribeAccessPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAccessPolicy
func (c *IoTSiteWise) DescribeAccessPolicyWithContext(ctx aws.Context, input *DescribeAccessPolicyInput, opts ...request.Option) (*DescribeAccessPolicyOutput, error)
DescribeAccessPolicyWithContext is the same as DescribeAccessPolicy with the addition of the ability to pass a context and additional request options.
See DescribeAccessPolicy for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) DescribeAsset(input *DescribeAssetInput) (*DescribeAssetOutput, error)
DescribeAsset API operation for AWS IoT SiteWise.
Retrieves information about an asset.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeAsset for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAsset
func (c *IoTSiteWise) DescribeAssetModel(input *DescribeAssetModelInput) (*DescribeAssetModelOutput, error)
DescribeAssetModel API operation for AWS IoT SiteWise.
Retrieves information about an asset model.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeAssetModel for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAssetModel
func (c *IoTSiteWise) DescribeAssetModelRequest(input *DescribeAssetModelInput) (req *request.Request, output *DescribeAssetModelOutput)
DescribeAssetModelRequest generates a "aws/request.Request" representing the client's request for the DescribeAssetModel operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeAssetModel for more information on using the DescribeAssetModel API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeAssetModelRequest method. req, resp := client.DescribeAssetModelRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAssetModel
func (c *IoTSiteWise) DescribeAssetModelWithContext(ctx aws.Context, input *DescribeAssetModelInput, opts ...request.Option) (*DescribeAssetModelOutput, error)
DescribeAssetModelWithContext is the same as DescribeAssetModel with the addition of the ability to pass a context and additional request options.
See DescribeAssetModel for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) DescribeAssetProperty(input *DescribeAssetPropertyInput) (*DescribeAssetPropertyOutput, error)
DescribeAssetProperty API operation for AWS IoT SiteWise.
Retrieves information about an asset property.
When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.
This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_GetAssetPropertyValue.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeAssetProperty for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAssetProperty
func (c *IoTSiteWise) DescribeAssetPropertyRequest(input *DescribeAssetPropertyInput) (req *request.Request, output *DescribeAssetPropertyOutput)
DescribeAssetPropertyRequest generates a "aws/request.Request" representing the client's request for the DescribeAssetProperty operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeAssetProperty for more information on using the DescribeAssetProperty API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeAssetPropertyRequest method. req, resp := client.DescribeAssetPropertyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAssetProperty
func (c *IoTSiteWise) DescribeAssetPropertyWithContext(ctx aws.Context, input *DescribeAssetPropertyInput, opts ...request.Option) (*DescribeAssetPropertyOutput, error)
DescribeAssetPropertyWithContext is the same as DescribeAssetProperty with the addition of the ability to pass a context and additional request options.
See DescribeAssetProperty for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) DescribeAssetRequest(input *DescribeAssetInput) (req *request.Request, output *DescribeAssetOutput)
DescribeAssetRequest generates a "aws/request.Request" representing the client's request for the DescribeAsset operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeAsset for more information on using the DescribeAsset API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeAssetRequest method. req, resp := client.DescribeAssetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAsset
func (c *IoTSiteWise) DescribeAssetWithContext(ctx aws.Context, input *DescribeAssetInput, opts ...request.Option) (*DescribeAssetOutput, error)
DescribeAssetWithContext is the same as DescribeAsset with the addition of the ability to pass a context and additional request options.
See DescribeAsset for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) DescribeDashboard(input *DescribeDashboardInput) (*DescribeDashboardOutput, error)
DescribeDashboard API operation for AWS IoT SiteWise.
Retrieves information about a dashboard.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeDashboard for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeDashboard
func (c *IoTSiteWise) DescribeDashboardRequest(input *DescribeDashboardInput) (req *request.Request, output *DescribeDashboardOutput)
DescribeDashboardRequest generates a "aws/request.Request" representing the client's request for the DescribeDashboard operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeDashboard for more information on using the DescribeDashboard API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeDashboardRequest method. req, resp := client.DescribeDashboardRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeDashboard
func (c *IoTSiteWise) DescribeDashboardWithContext(ctx aws.Context, input *DescribeDashboardInput, opts ...request.Option) (*DescribeDashboardOutput, error)
DescribeDashboardWithContext is the same as DescribeDashboard with the addition of the ability to pass a context and additional request options.
See DescribeDashboard for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) DescribeDefaultEncryptionConfiguration(input *DescribeDefaultEncryptionConfigurationInput) (*DescribeDefaultEncryptionConfigurationOutput, error)
DescribeDefaultEncryptionConfiguration API operation for AWS IoT SiteWise.
Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, see Key management (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html) in the IoT SiteWise User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeDefaultEncryptionConfiguration for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide.
func (c *IoTSiteWise) DescribeDefaultEncryptionConfigurationRequest(input *DescribeDefaultEncryptionConfigurationInput) (req *request.Request, output *DescribeDefaultEncryptionConfigurationOutput)
DescribeDefaultEncryptionConfigurationRequest generates a "aws/request.Request" representing the client's request for the DescribeDefaultEncryptionConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeDefaultEncryptionConfiguration for more information on using the DescribeDefaultEncryptionConfiguration API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeDefaultEncryptionConfigurationRequest method. req, resp := client.DescribeDefaultEncryptionConfigurationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (c *IoTSiteWise) DescribeDefaultEncryptionConfigurationWithContext(ctx aws.Context, input *DescribeDefaultEncryptionConfigurationInput, opts ...request.Option) (*DescribeDefaultEncryptionConfigurationOutput, error)
DescribeDefaultEncryptionConfigurationWithContext is the same as DescribeDefaultEncryptionConfiguration with the addition of the ability to pass a context and additional request options.
See DescribeDefaultEncryptionConfiguration for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *IoTSiteWise) DescribeGateway(input *DescribeGatewayInput) (*DescribeGatewayOutput, error)
DescribeGateway API operation for AWS IoT SiteWise.
Retrieves information about a gateway.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeGateway for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide.
See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeGateway
func (c *IoTSiteWise) DescribeGatewayCapabilityConfiguration(input *DescribeGatewayCapabilityConfigurationInput) (*DescribeGatewayCapabilityConfigurationOutput, error)
DescribeGatewayCapabilityConfiguration API operation for AWS IoT SiteWise.
Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeGatewayCapabilityConfiguration for usage and error information.
Returned Error Types:
* InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again. * ResourceNotFoundException The requested resource can't be found. * InternalFailureException IoT SiteWise can't process your request right now. Try again later. * ThrottlingException 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the IoT SiteWise User Guide.
func (c *IoTSiteWise) DescribeGatewayCapabilityConfigurationRequest(input *DescribeGatewayCapabilityConfigurationInput) (req *request.Request, output *DescribeGatewayCapabilityConfigurationOutput)
DescribeGatewayCapabilityConfigurationRequest generates a "aws/request.Request" representing the client's request for the DescribeGatewayCapabilityConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeGatewayCapabilityConfiguration for more information on using the DescribeGatewayCapabilityConfiguration API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeGatewayCapabilityConfigurationR