iotsitewise

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 9 Imported by: 10

Documentation

Overview

Package iotsitewise provides the client and types for making API requests to AWS IoT SiteWise.

Welcome to the AWS IoT SiteWise API Reference. AWS IoT SiteWise is an AWS service that connects Industrial Internet of Things (IIoT) (https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications) devices to the power of the AWS Cloud. For more information, see the AWS IoT SiteWise User Guide (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/). For information about AWS IoT SiteWise quotas, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the AWS IoT SiteWise User Guide.

See https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02 for more information on this service.

See iotsitewise package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/iotsitewise/

Using the Client

To use AWS IoT SiteWise with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS IoT SiteWise client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/iotsitewise/#New

Index

Constants

View Source 
const (
	ServiceName = "AWS IoT SiteWise" // Service's name
	ServiceID   = "IoTSiteWise"      // Service's identifier
	EndpointsID = "iotsitewise"      // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeConflictingOperationException for service response error code
	// "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.
	ErrCodeConflictingOperationException = "ConflictingOperationException"

	// ErrCodeInternalFailureException for service response error code
	// "InternalFailureException".
	//
	// AWS IoT SiteWise can't process your request right now. Try again later.
	ErrCodeInternalFailureException = "InternalFailureException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The request isn't valid. This can occur if your request contains malformed
	// JSON or unsupported characters. Check your request and try again.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeLimitExceededException for service response error code
	// "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 AWS IoT SiteWise User Guide.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// The resource already exists.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The requested resource can't be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The requested service is unavailable.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

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

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

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessPolicySummary 

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 AWS SSO identity (a user or group).
	//
	// 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 Permission `locationName:"permission" type:"string" required:"true" enum:"true"`

	// The AWS 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 AWS SSO identity's access to an AWS IoT SiteWise Monitor resource.

func (AccessPolicySummary) MarshalFields 

func (s AccessPolicySummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AccessPolicySummary) String 

func (s AccessPolicySummary) String() string

String returns the string representation

type AggregateType 

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

Enum values for AggregateType

func (AggregateType) MarshalValue 

func (enum AggregateType) MarshalValue() (string, error)

func (AggregateType) MarshalValueBuf 

func (enum AggregateType) MarshalValueBuf(b []byte) ([]byte, error)

type AggregatedValue 

type AggregatedValue struct {

	// The quality of the aggregated data.
	Quality Quality `locationName:"quality" type:"string" enum:"true"`

	// 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 (AggregatedValue) MarshalFields 

func (s AggregatedValue) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AggregatedValue) String 

func (s AggregatedValue) String() string

String returns the string representation

type Aggregates 

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 (Aggregates) MarshalFields 

func (s Aggregates) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Aggregates) String 

func (s Aggregates) String() string

String returns the string representation

type AssetErrorCode 

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

Enum values for AssetErrorCode

func (AssetErrorCode) MarshalValue 

func (enum AssetErrorCode) MarshalValue() (string, error)

func (AssetErrorCode) MarshalValueBuf 

func (enum AssetErrorCode) MarshalValueBuf(b []byte) ([]byte, error)

type AssetErrorDetails 

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 AssetErrorCode `locationName:"code" type:"string" required:"true" enum:"true"`

	// 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 (AssetErrorDetails) MarshalFields 

func (s AssetErrorDetails) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssetErrorDetails) String 

func (s AssetErrorDetails) String() string

String returns the string representation

type AssetHierarchy 

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.
	//
	// 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 (AssetHierarchy) MarshalFields 

func (s AssetHierarchy) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssetHierarchy) String 

func (s AssetHierarchy) String() string

String returns the string representation

type AssetModelHierarchy 

type AssetModelHierarchy struct {

	// The ID of the asset model. All assets in this hierarchy must be instances
	// of the childAssetModelId asset model.
	//
	// ChildAssetModelId 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.
	//
	// 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 (AssetModelHierarchy) MarshalFields 

func (s AssetModelHierarchy) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssetModelHierarchy) String 

func (s AssetModelHierarchy) String() string

String returns the string representation

func (*AssetModelHierarchy) Validate 

func (s *AssetModelHierarchy) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssetModelHierarchyDefinition 

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 CreateAssetModel
	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html)
	// or UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)).
	//
	// Name 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 (AssetModelHierarchyDefinition) MarshalFields 

func (s AssetModelHierarchyDefinition) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssetModelHierarchyDefinition) String 

func (s AssetModelHierarchyDefinition) String() string

String returns the string representation

func (*AssetModelHierarchyDefinition) Validate 

func (s *AssetModelHierarchyDefinition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssetModelProperty 

type AssetModelProperty struct {

	// The data type of the asset model property.
	//
	// DataType is a required field
	DataType PropertyDataType `locationName:"dataType" type:"string" required:"true" enum:"true"`

	// 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 (AssetModelProperty) MarshalFields 

func (s AssetModelProperty) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssetModelProperty) String 

func (s AssetModelProperty) String() string

String returns the string representation

func (*AssetModelProperty) Validate 

func (s *AssetModelProperty) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssetModelPropertyDefinition 

type AssetModelPropertyDefinition struct {

	// The data type of the property definition.
	//
	// DataType is a required field
	DataType PropertyDataType `locationName:"dataType" type:"string" required:"true" enum:"true"`

	// 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 (AssetModelPropertyDefinition) MarshalFields 

func (s AssetModelPropertyDefinition) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssetModelPropertyDefinition) String 

func (s AssetModelPropertyDefinition) String() string

String returns the string representation

func (*AssetModelPropertyDefinition) Validate 

func (s *AssetModelPropertyDefinition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssetModelState 

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

Enum values for AssetModelState

func (AssetModelState) MarshalValue 

func (enum AssetModelState) MarshalValue() (string, error)

func (AssetModelState) MarshalValueBuf 

func (enum AssetModelState) MarshalValueBuf(b []byte) ([]byte, error)

type AssetModelStatus 

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 AssetModelState `locationName:"state" type:"string" required:"true" enum:"true"`
	// 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 AWS IoT SiteWise User Guide.

func (AssetModelStatus) MarshalFields 

func (s AssetModelStatus) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssetModelStatus) String 

func (s AssetModelStatus) String() string

String returns the string representation

type AssetModelSummary 

type AssetModelSummary struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the asset model, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
	//
	// 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 AWS 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 (AssetModelSummary) MarshalFields 

func (s AssetModelSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssetModelSummary) String 

func (s AssetModelSummary) String() string

String returns the string representation

type AssetProperty 

type AssetProperty struct {

	// The property alias that identifies the property, such as an OPC-UA server
	// data stream path (for example, /company/windfarm/3/turbine/7/temperature).
	// For more information, see Mapping Industrial Data Streams to Asset Properties
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the AWS IoT SiteWise User Guide.
	Alias *string `locationName:"alias" min:"1" type:"string"`

	// The data type of the asset property.
	//
	// DataType is a required field
	DataType PropertyDataType `locationName:"dataType" type:"string" required:"true" enum:"true"`

	// 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 (AssetProperty) MarshalFields 

func (s AssetProperty) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssetProperty) String 

func (s AssetProperty) String() string

String returns the string representation

type AssetPropertyValue 

type AssetPropertyValue struct {

	// The quality of the asset property value.
	Quality Quality `locationName:"quality" type:"string" enum:"true"`

	// 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 (AssetPropertyValue) MarshalFields 

func (s AssetPropertyValue) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssetPropertyValue) String 

func (s AssetPropertyValue) String() string

String returns the string representation

func (*AssetPropertyValue) Validate 

func (s *AssetPropertyValue) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssetState 

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

Enum values for AssetState

func (AssetState) MarshalValue 

func (enum AssetState) MarshalValue() (string, error)

func (AssetState) MarshalValueBuf 

func (enum AssetState) MarshalValueBuf(b []byte) ([]byte, error)

type AssetStatus 

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 AssetState `locationName:"state" type:"string" required:"true" enum:"true"`
	// 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 AWS IoT SiteWise User Guide.

func (AssetStatus) MarshalFields 

func (s AssetStatus) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssetStatus) String 

func (s AssetStatus) String() string

String returns the string representation

type AssetSummary 

type AssetSummary struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the asset, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
	//
	// 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 (AssetSummary) MarshalFields 

func (s AssetSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssetSummary) String 

func (s AssetSummary) String() string

String returns the string representation

type AssociateAssetsInput 

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 AWS 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 (AssociateAssetsInput) MarshalFields 

func (s AssociateAssetsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssociateAssetsInput) String 

func (s AssociateAssetsInput) String() string

String returns the string representation

func (*AssociateAssetsInput) Validate 

func (s *AssociateAssetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateAssetsOutput 

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

func (AssociateAssetsOutput) MarshalFields 

func (s AssociateAssetsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssociateAssetsOutput) String 

func (s AssociateAssetsOutput) String() string

String returns the string representation

type AssociateAssetsRequest 

type AssociateAssetsRequest struct {
	*aws.Request
	Input *AssociateAssetsInput
	Copy  func(*AssociateAssetsInput) AssociateAssetsRequest
}

AssociateAssetsRequest is the request type for the AssociateAssets API operation.

func (AssociateAssetsRequest) Send 

func (r AssociateAssetsRequest) Send(ctx context.Context) (*AssociateAssetsResponse, error)

Send marshals and sends the AssociateAssets API request.

type AssociateAssetsResponse 

type AssociateAssetsResponse struct {
	*AssociateAssetsOutput
	// contains filtered or unexported fields
}

AssociateAssetsResponse is the response type for the AssociateAssets API operation.

func (*AssociateAssetsResponse) SDKResponseMetdata 

func (r *AssociateAssetsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AssociateAssets request.

type AssociatedAssetsSummary 

type AssociatedAssetsSummary struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the asset, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
	//
	// 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 (AssociatedAssetsSummary) MarshalFields 

func (s AssociatedAssetsSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssociatedAssetsSummary) String 

func (s AssociatedAssetsSummary) String() string

String returns the string representation

type Attribute 

type Attribute struct {

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

func (Attribute) MarshalFields 

func (s Attribute) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Attribute) String 

func (s Attribute) String() string

String returns the string representation

func (*Attribute) Validate 

func (s *Attribute) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchAssociateProjectAssetsInput 

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 (BatchAssociateProjectAssetsInput) MarshalFields 

func (s BatchAssociateProjectAssetsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchAssociateProjectAssetsInput) String 

func (s BatchAssociateProjectAssetsInput) String() string

String returns the string representation

func (*BatchAssociateProjectAssetsInput) Validate 

func (s *BatchAssociateProjectAssetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchAssociateProjectAssetsOutput 

type BatchAssociateProjectAssetsOutput struct {

	// A list of associated error information, if any.
	Errors []AssetErrorDetails `locationName:"errors" type:"list"`
	// contains filtered or unexported fields
}

func (BatchAssociateProjectAssetsOutput) MarshalFields 

func (s BatchAssociateProjectAssetsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchAssociateProjectAssetsOutput) String 

func (s BatchAssociateProjectAssetsOutput) String() string

String returns the string representation

type BatchAssociateProjectAssetsRequest 

type BatchAssociateProjectAssetsRequest struct {
	*aws.Request
	Input *BatchAssociateProjectAssetsInput
	Copy  func(*BatchAssociateProjectAssetsInput) BatchAssociateProjectAssetsRequest
}

BatchAssociateProjectAssetsRequest is the request type for the BatchAssociateProjectAssets API operation.

func (BatchAssociateProjectAssetsRequest) Send 

func (r BatchAssociateProjectAssetsRequest) Send(ctx context.Context) (*BatchAssociateProjectAssetsResponse, error)

Send marshals and sends the BatchAssociateProjectAssets API request.

type BatchAssociateProjectAssetsResponse 

type BatchAssociateProjectAssetsResponse struct {
	*BatchAssociateProjectAssetsOutput
	// contains filtered or unexported fields
}

BatchAssociateProjectAssetsResponse is the response type for the BatchAssociateProjectAssets API operation.

func (*BatchAssociateProjectAssetsResponse) SDKResponseMetdata 

func (r *BatchAssociateProjectAssetsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the BatchAssociateProjectAssets request.

type BatchDisassociateProjectAssetsInput 

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 (BatchDisassociateProjectAssetsInput) MarshalFields 

func (s BatchDisassociateProjectAssetsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchDisassociateProjectAssetsInput) String 

func (s BatchDisassociateProjectAssetsInput) String() string

String returns the string representation

func (*BatchDisassociateProjectAssetsInput) Validate 

func (s *BatchDisassociateProjectAssetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDisassociateProjectAssetsOutput 

type BatchDisassociateProjectAssetsOutput struct {

	// A list of associated error information, if any.
	Errors []AssetErrorDetails `locationName:"errors" type:"list"`
	// contains filtered or unexported fields
}

func (BatchDisassociateProjectAssetsOutput) MarshalFields 

func (s BatchDisassociateProjectAssetsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchDisassociateProjectAssetsOutput) String 

func (s BatchDisassociateProjectAssetsOutput) String() string

String returns the string representation

type BatchDisassociateProjectAssetsRequest 

type BatchDisassociateProjectAssetsRequest struct {
	*aws.Request
	Input *BatchDisassociateProjectAssetsInput
	Copy  func(*BatchDisassociateProjectAssetsInput) BatchDisassociateProjectAssetsRequest
}

BatchDisassociateProjectAssetsRequest is the request type for the BatchDisassociateProjectAssets API operation.

func (BatchDisassociateProjectAssetsRequest) Send 

func (r BatchDisassociateProjectAssetsRequest) Send(ctx context.Context) (*BatchDisassociateProjectAssetsResponse, error)

Send marshals and sends the BatchDisassociateProjectAssets API request.

type BatchDisassociateProjectAssetsResponse 

type BatchDisassociateProjectAssetsResponse struct {
	*BatchDisassociateProjectAssetsOutput
	// contains filtered or unexported fields
}

BatchDisassociateProjectAssetsResponse is the response type for the BatchDisassociateProjectAssets API operation.

func (*BatchDisassociateProjectAssetsResponse) SDKResponseMetdata 

func (r *BatchDisassociateProjectAssetsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the BatchDisassociateProjectAssets request.

type BatchPutAssetPropertyError 

type BatchPutAssetPropertyError struct {

	// The error code.
	//
	// ErrorCode is a required field
	ErrorCode BatchPutAssetPropertyValueErrorCode `locationName:"errorCode" type:"string" required:"true" enum:"true"`

	// 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 (BatchPutAssetPropertyError) MarshalFields 

func (s BatchPutAssetPropertyError) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchPutAssetPropertyError) String 

func (s BatchPutAssetPropertyError) String() string

String returns the string representation

type BatchPutAssetPropertyErrorEntry 

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 (BatchPutAssetPropertyErrorEntry) MarshalFields 

func (s BatchPutAssetPropertyErrorEntry) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchPutAssetPropertyErrorEntry) String 

func (s BatchPutAssetPropertyErrorEntry) String() string

String returns the string representation

type BatchPutAssetPropertyValueErrorCode 

type BatchPutAssetPropertyValueErrorCode string
const (
	BatchPutAssetPropertyValueErrorCodeResourceNotFoundException     BatchPutAssetPropertyValueErrorCode = "ResourceNotFoundException"
	BatchPutAssetPropertyValueErrorCodeInvalidRequestException       BatchPutAssetPropertyValueErrorCode = "InvalidRequestException"
	BatchPutAssetPropertyValueErrorCodeInternalFailureException      BatchPutAssetPropertyValueErrorCode = "InternalFailureException"
	BatchPutAssetPropertyValueErrorCodeServiceUnavailableException   BatchPutAssetPropertyValueErrorCode = "ServiceUnavailableException"
	BatchPutAssetPropertyValueErrorCodeThrottlingException           BatchPutAssetPropertyValueErrorCode = "ThrottlingException"
	BatchPutAssetPropertyValueErrorCodeLimitExceededException        BatchPutAssetPropertyValueErrorCode = "LimitExceededException"
	BatchPutAssetPropertyValueErrorCodeConflictingOperationException BatchPutAssetPropertyValueErrorCode = "ConflictingOperationException"
	BatchPutAssetPropertyValueErrorCodeTimestampOutOfRangeException  BatchPutAssetPropertyValueErrorCode = "TimestampOutOfRangeException"
	BatchPutAssetPropertyValueErrorCodeAccessDeniedException         BatchPutAssetPropertyValueErrorCode = "AccessDeniedException"
)

Enum values for BatchPutAssetPropertyValueErrorCode

func (BatchPutAssetPropertyValueErrorCode) MarshalValue 

func (enum BatchPutAssetPropertyValueErrorCode) MarshalValue() (string, error)

func (BatchPutAssetPropertyValueErrorCode) MarshalValueBuf 

func (enum BatchPutAssetPropertyValueErrorCode) MarshalValueBuf(b []byte) ([]byte, error)

type BatchPutAssetPropertyValueInput 

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 (BatchPutAssetPropertyValueInput) MarshalFields 

func (s BatchPutAssetPropertyValueInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchPutAssetPropertyValueInput) String 

func (s BatchPutAssetPropertyValueInput) String() string

String returns the string representation

func (*BatchPutAssetPropertyValueInput) Validate 

func (s *BatchPutAssetPropertyValueInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchPutAssetPropertyValueOutput 

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 (BatchPutAssetPropertyValueOutput) MarshalFields 

func (s BatchPutAssetPropertyValueOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BatchPutAssetPropertyValueOutput) String 

func (s BatchPutAssetPropertyValueOutput) String() string

String returns the string representation

type BatchPutAssetPropertyValueRequest 

type BatchPutAssetPropertyValueRequest struct {
	*aws.Request
	Input *BatchPutAssetPropertyValueInput
	Copy  func(*BatchPutAssetPropertyValueInput) BatchPutAssetPropertyValueRequest
}

BatchPutAssetPropertyValueRequest is the request type for the BatchPutAssetPropertyValue API operation.

func (BatchPutAssetPropertyValueRequest) Send 

func (r BatchPutAssetPropertyValueRequest) Send(ctx context.Context) (*BatchPutAssetPropertyValueResponse, error)

Send marshals and sends the BatchPutAssetPropertyValue API request.

type BatchPutAssetPropertyValueResponse 

type BatchPutAssetPropertyValueResponse struct {
	*BatchPutAssetPropertyValueOutput
	// contains filtered or unexported fields
}

BatchPutAssetPropertyValueResponse is the response type for the BatchPutAssetPropertyValue API operation.

func (*BatchPutAssetPropertyValueResponse) SDKResponseMetdata 

func (r *BatchPutAssetPropertyValueResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the BatchPutAssetPropertyValue request.

type CapabilitySyncStatus 

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

Enum values for CapabilitySyncStatus

func (CapabilitySyncStatus) MarshalValue 

func (enum CapabilitySyncStatus) MarshalValue() (string, error)

func (CapabilitySyncStatus) MarshalValueBuf 

func (enum CapabilitySyncStatus) MarshalValueBuf(b []byte) ([]byte, error)

type Client 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to AWS IoT SiteWise. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := iotsitewise.New(myConfig)

func (*Client) AssociateAssetsRequest 

func (c *Client) AssociateAssetsRequest(input *AssociateAssetsInput) AssociateAssetsRequest

AssociateAssetsRequest returns a request value for making 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 AWS IoT SiteWise User Guide. 

// Example sending a request using AssociateAssetsRequest.
req := client.AssociateAssetsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/AssociateAssets

func (*Client) BatchAssociateProjectAssetsRequest 

func (c *Client) BatchAssociateProjectAssetsRequest(input *BatchAssociateProjectAssetsInput) BatchAssociateProjectAssetsRequest

BatchAssociateProjectAssetsRequest returns a request value for making API operation for AWS IoT SiteWise.

Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project. 

// Example sending a request using BatchAssociateProjectAssetsRequest.
req := client.BatchAssociateProjectAssetsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchAssociateProjectAssets

func (*Client) BatchDisassociateProjectAssetsRequest 

func (c *Client) BatchDisassociateProjectAssetsRequest(input *BatchDisassociateProjectAssetsInput) BatchDisassociateProjectAssetsRequest

BatchDisassociateProjectAssetsRequest returns a request value for making API operation for AWS IoT SiteWise.

Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project. 

// Example sending a request using BatchDisassociateProjectAssetsRequest.
req := client.BatchDisassociateProjectAssetsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchDisassociateProjectAssets

func (*Client) BatchPutAssetPropertyValueRequest 

func (c *Client) BatchPutAssetPropertyValueRequest(input *BatchPutAssetPropertyValueInput) BatchPutAssetPropertyValueRequest

BatchPutAssetPropertyValueRequest returns a request value for making API operation for AWS IoT SiteWise.

Sends a list of asset property values to AWS 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 AWS IoT SiteWise User Guide.

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

With respect to Unix epoch time, AWS IoT SiteWise accepts only TQVs that have a timestamp of no more than 15 minutes in the past and no more than 5 minutes in the future. AWS IoT SiteWise rejects timestamps outside of the inclusive range of [-15, +5] minutes and returns a TimestampOutOfRangeException error.

For each asset property, AWS 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. 

// Example sending a request using BatchPutAssetPropertyValueRequest.
req := client.BatchPutAssetPropertyValueRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchPutAssetPropertyValue

func (*Client) CreateAccessPolicyRequest 

func (c *Client) CreateAccessPolicyRequest(input *CreateAccessPolicyInput) CreateAccessPolicyRequest

CreateAccessPolicyRequest returns a request value for making API operation for AWS IoT SiteWise.

Creates an access policy that grants the specified AWS Single Sign-On user or group access to the specified AWS IoT SiteWise Monitor portal or project resource. 

// Example sending a request using CreateAccessPolicyRequest.
req := client.CreateAccessPolicyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateAccessPolicy

func (*Client) CreateAssetModelRequest 

func (c *Client) CreateAssetModelRequest(input *CreateAssetModelInput) CreateAssetModelRequest

CreateAssetModelRequest returns a request value for making 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 AWS IoT SiteWise User Guide. 

// Example sending a request using CreateAssetModelRequest.
req := client.CreateAssetModelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateAssetModel

func (*Client) CreateAssetRequest 

func (c *Client) CreateAssetRequest(input *CreateAssetInput) CreateAssetRequest

CreateAssetRequest returns a request value for making 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 AWS IoT SiteWise User Guide. 

// Example sending a request using CreateAssetRequest.
req := client.CreateAssetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateAsset

func (*Client) CreateDashboardRequest 

func (c *Client) CreateDashboardRequest(input *CreateDashboardInput) CreateDashboardRequest

CreateDashboardRequest returns a request value for making API operation for AWS IoT SiteWise.

Creates a dashboard in an AWS IoT SiteWise Monitor project. 

// Example sending a request using CreateDashboardRequest.
req := client.CreateDashboardRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateDashboard

func (*Client) CreateGatewayRequest 

func (c *Client) CreateGatewayRequest(input *CreateGatewayInput) CreateGatewayRequest

CreateGatewayRequest returns a request value for making 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 AWS IoT SiteWise. For more information, see Ingesting data using a gateway (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html) in the AWS IoT SiteWise User Guide. 

// Example sending a request using CreateGatewayRequest.
req := client.CreateGatewayRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateGateway

func (*Client) CreatePortalRequest 

func (c *Client) CreatePortalRequest(input *CreatePortalInput) CreatePortalRequest

CreatePortalRequest returns a request value for making API operation for AWS IoT SiteWise.

Creates a portal, which can contain projects and dashboards. Before you can create a portal, you must configure AWS Single Sign-On in the current Region. AWS IoT SiteWise Monitor uses AWS SSO to manage user permissions. For more information, see Enabling AWS SSO (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso) in the AWS IoT SiteWise User Guide.

Before you can sign in to a new portal, you must add at least one AWS SSO user or group 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 AWS IoT SiteWise User Guide. 

// Example sending a request using CreatePortalRequest.
req := client.CreatePortalRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreatePortal

func (*Client) CreateProjectRequest 

func (c *Client) CreateProjectRequest(input *CreateProjectInput) CreateProjectRequest

CreateProjectRequest returns a request value for making API operation for AWS IoT SiteWise.

Creates a project in the specified portal. 

// Example sending a request using CreateProjectRequest.
req := client.CreateProjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateProject

func (*Client) DeleteAccessPolicyRequest 

func (c *Client) DeleteAccessPolicyRequest(input *DeleteAccessPolicyInput) DeleteAccessPolicyRequest

DeleteAccessPolicyRequest returns a request value for making API operation for AWS IoT SiteWise.

Deletes an access policy that grants the specified AWS Single Sign-On identity access to the specified AWS IoT SiteWise Monitor resource. You can use this operation to revoke access to an AWS IoT SiteWise Monitor resource. 

// Example sending a request using DeleteAccessPolicyRequest.
req := client.DeleteAccessPolicyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteAccessPolicy

func (*Client) DeleteAssetModelRequest 

func (c *Client) DeleteAssetModelRequest(input *DeleteAssetModelInput) DeleteAssetModelRequest

DeleteAssetModelRequest returns a request value for making 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 AWS IoT SiteWise User Guide. 

// Example sending a request using DeleteAssetModelRequest.
req := client.DeleteAssetModelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteAssetModel

func (*Client) DeleteAssetRequest 

func (c *Client) DeleteAssetRequest(input *DeleteAssetInput) DeleteAssetRequest

DeleteAssetRequest returns a request value for making 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 AWS 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). 

// Example sending a request using DeleteAssetRequest.
req := client.DeleteAssetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteAsset

func (*Client) DeleteDashboardRequest 

func (c *Client) DeleteDashboardRequest(input *DeleteDashboardInput) DeleteDashboardRequest

DeleteDashboardRequest returns a request value for making API operation for AWS IoT SiteWise.

Deletes a dashboard from AWS IoT SiteWise Monitor. 

// Example sending a request using DeleteDashboardRequest.
req := client.DeleteDashboardRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteDashboard

func (*Client) DeleteGatewayRequest 

func (c *Client) DeleteGatewayRequest(input *DeleteGatewayInput) DeleteGatewayRequest

DeleteGatewayRequest returns a request value for making API operation for AWS IoT SiteWise.

Deletes a gateway from AWS IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system. For more information, see Data retention (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-retention.html) in the AWS IoT SiteWise User Guide. 

// Example sending a request using DeleteGatewayRequest.
req := client.DeleteGatewayRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteGateway

func (*Client) DeletePortalRequest 

func (c *Client) DeletePortalRequest(input *DeletePortalInput) DeletePortalRequest

DeletePortalRequest returns a request value for making API operation for AWS IoT SiteWise.

Deletes a portal from AWS IoT SiteWise Monitor. 

// Example sending a request using DeletePortalRequest.
req := client.DeletePortalRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeletePortal

func (*Client) DeleteProjectRequest 

func (c *Client) DeleteProjectRequest(input *DeleteProjectInput) DeleteProjectRequest

DeleteProjectRequest returns a request value for making API operation for AWS IoT SiteWise.

Deletes a project from AWS IoT SiteWise Monitor. 

// Example sending a request using DeleteProjectRequest.
req := client.DeleteProjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteProject

func (*Client) DescribeAccessPolicyRequest 

func (c *Client) DescribeAccessPolicyRequest(input *DescribeAccessPolicyInput) DescribeAccessPolicyRequest

DescribeAccessPolicyRequest returns a request value for making API operation for AWS IoT SiteWise.

Describes an access policy, which specifies an AWS SSO user or group's access to an AWS IoT SiteWise Monitor portal or project. 

// Example sending a request using DescribeAccessPolicyRequest.
req := client.DescribeAccessPolicyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAccessPolicy

func (*Client) DescribeAssetModelRequest 

func (c *Client) DescribeAssetModelRequest(input *DescribeAssetModelInput) DescribeAssetModelRequest

DescribeAssetModelRequest returns a request value for making API operation for AWS IoT SiteWise.

Retrieves information about an asset model. 

// Example sending a request using DescribeAssetModelRequest.
req := client.DescribeAssetModelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAssetModel

func (*Client) DescribeAssetPropertyRequest 

func (c *Client) DescribeAssetPropertyRequest(input *DescribeAssetPropertyInput) DescribeAssetPropertyRequest

DescribeAssetPropertyRequest returns a request value for making API operation for AWS IoT SiteWise.

Retrieves information about an asset's property. 

// Example sending a request using DescribeAssetPropertyRequest.
req := client.DescribeAssetPropertyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAssetProperty

func (*Client) DescribeAssetRequest 

func (c *Client) DescribeAssetRequest(input *DescribeAssetInput) DescribeAssetRequest

DescribeAssetRequest returns a request value for making API operation for AWS IoT SiteWise.

Retrieves information about an asset. 

// Example sending a request using DescribeAssetRequest.
req := client.DescribeAssetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAsset

func (*Client) DescribeDashboardRequest 

func (c *Client) DescribeDashboardRequest(input *DescribeDashboardInput) DescribeDashboardRequest

DescribeDashboardRequest returns a request value for making API operation for AWS IoT SiteWise.

Retrieves information about a dashboard. 

// Example sending a request using DescribeDashboardRequest.
req := client.DescribeDashboardRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeDashboard

func (*Client) DescribeGatewayCapabilityConfigurationRequest 

func (c *Client) DescribeGatewayCapabilityConfigurationRequest(input *DescribeGatewayCapabilityConfigurationInput) DescribeGatewayCapabilityConfigurationRequest

DescribeGatewayCapabilityConfigurationRequest returns a request value for making 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 AWS 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). 

// Example sending a request using DescribeGatewayCapabilityConfigurationRequest.
req := client.DescribeGatewayCapabilityConfigurationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeGatewayCapabilityConfiguration

func (*Client) DescribeGatewayRequest 

func (c *Client) DescribeGatewayRequest(input *DescribeGatewayInput) DescribeGatewayRequest

DescribeGatewayRequest returns a request value for making API operation for AWS IoT SiteWise.

Retrieves information about a gateway. 

// Example sending a request using DescribeGatewayRequest.
req := client.DescribeGatewayRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeGateway

func (*Client) DescribeLoggingOptionsRequest 

func (c *Client) DescribeLoggingOptionsRequest(input *DescribeLoggingOptionsInput) DescribeLoggingOptionsRequest

DescribeLoggingOptionsRequest returns a request value for making API operation for AWS IoT SiteWise.

Retrieves the current AWS IoT SiteWise logging options. 

// Example sending a request using DescribeLoggingOptionsRequest.
req := client.DescribeLoggingOptionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeLoggingOptions

func (*Client) DescribePortalRequest 

func (c *Client) DescribePortalRequest(input *DescribePortalInput) DescribePortalRequest

DescribePortalRequest returns a request value for making API operation for AWS IoT SiteWise.

Retrieves information about a portal. 

// Example sending a request using DescribePortalRequest.
req := client.DescribePortalRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribePortal

func (*Client) DescribeProjectRequest 

func (c *Client) DescribeProjectRequest(input *DescribeProjectInput) DescribeProjectRequest

DescribeProjectRequest returns a request value for making API operation for AWS IoT SiteWise.

Retrieves information about a project. 

// Example sending a request using DescribeProjectRequest.
req := client.DescribeProjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeProject

func (*Client) DisassociateAssetsRequest 

func (c *Client) DisassociateAssetsRequest(input *DisassociateAssetsInput) DisassociateAssetsRequest

DisassociateAssetsRequest returns a request value for making API operation for AWS IoT SiteWise.

Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model. 

// Example sending a request using DisassociateAssetsRequest.
req := client.DisassociateAssetsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DisassociateAssets

func (*Client) GetAssetPropertyAggregatesRequest 

func (c *Client) GetAssetPropertyAggregatesRequest(input *GetAssetPropertyAggregatesInput) GetAssetPropertyAggregatesRequest

GetAssetPropertyAggregatesRequest returns a request value for making API operation for AWS IoT SiteWise.

Gets aggregated values for an asset property. For more information, see Querying Aggregated Property Values (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates) in the AWS 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).

    // Example sending a request using GetAssetPropertyAggregatesRequest. req := client.GetAssetPropertyAggregatesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/GetAssetPropertyAggregates

func (*Client) GetAssetPropertyValueHistoryRequest 

func (c *Client) GetAssetPropertyValueHistoryRequest(input *GetAssetPropertyValueHistoryInput) GetAssetPropertyValueHistoryRequest

GetAssetPropertyValueHistoryRequest returns a request value for making API operation for AWS IoT SiteWise.

Gets the history of an asset property's values. For more information, see Querying Historical Property Values (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values) in the AWS 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).

    // Example sending a request using GetAssetPropertyValueHistoryRequest. req := client.GetAssetPropertyValueHistoryRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/GetAssetPropertyValueHistory

func (*Client) GetAssetPropertyValueRequest 

func (c *Client) GetAssetPropertyValueRequest(input *GetAssetPropertyValueInput) GetAssetPropertyValueRequest

GetAssetPropertyValueRequest returns a request value for making API operation for AWS IoT SiteWise.

Gets an asset property's current value. For more information, see Querying Current Property Values (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values) in the AWS 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).

    // Example sending a request using GetAssetPropertyValueRequest. req := client.GetAssetPropertyValueRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/GetAssetPropertyValue

func (*Client) ListAccessPoliciesRequest 

func (c *Client) ListAccessPoliciesRequest(input *ListAccessPoliciesInput) ListAccessPoliciesRequest

ListAccessPoliciesRequest returns a request value for making API operation for AWS IoT SiteWise.

Retrieves a paginated list of access policies for an AWS SSO identity (a user or group) or an AWS IoT SiteWise Monitor resource (a portal or project). 

// Example sending a request using ListAccessPoliciesRequest.
req := client.ListAccessPoliciesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAccessPolicies

func (*Client) ListAssetModelsRequest 

func (c *Client) ListAssetModelsRequest(input *ListAssetModelsInput) ListAssetModelsRequest

ListAssetModelsRequest returns a request value for making API operation for AWS IoT SiteWise.

Retrieves a paginated list of summaries of all asset models. 

// Example sending a request using ListAssetModelsRequest.
req := client.ListAssetModelsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAssetModels

func (*Client) ListAssetsRequest 

func (c *Client) ListAssetsRequest(input *ListAssetsInput) ListAssetsRequest

ListAssetsRequest returns a request value for making API operation for AWS IoT SiteWise.

Retrieves a paginated list of asset summaries.

You can use this operation to do the following:

  • List assets based on a specific asset model.

  • List top-level assets.

You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssetModels.html) to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model. 

// Example sending a request using ListAssetsRequest.
req := client.ListAssetsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAssets

func (*Client) ListAssociatedAssetsRequest 

func (c *Client) ListAssociatedAssetsRequest(input *ListAssociatedAssetsInput) ListAssociatedAssetsRequest

ListAssociatedAssetsRequest returns a request value for making API operation for AWS IoT SiteWise.

Retrieves a paginated list of the assets associated to a parent asset (assetId) by a given hierarchy (hierarchyId). 

// Example sending a request using ListAssociatedAssetsRequest.
req := client.ListAssociatedAssetsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAssociatedAssets

func (*Client) ListDashboardsRequest 

func (c *Client) ListDashboardsRequest(input *ListDashboardsInput) ListDashboardsRequest

ListDashboardsRequest returns a request value for making API operation for AWS IoT SiteWise.

Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project. 

// Example sending a request using ListDashboardsRequest.
req := client.ListDashboardsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListDashboards

func (*Client) ListGatewaysRequest 

func (c *Client) ListGatewaysRequest(input *ListGatewaysInput) ListGatewaysRequest

ListGatewaysRequest returns a request value for making API operation for AWS IoT SiteWise.

Retrieves a paginated list of gateways. 

// Example sending a request using ListGatewaysRequest.
req := client.ListGatewaysRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListGateways

func (*Client) ListPortalsRequest 

func (c *Client) ListPortalsRequest(input *ListPortalsInput) ListPortalsRequest

ListPortalsRequest returns a request value for making API operation for AWS IoT SiteWise.

Retrieves a paginated list of AWS IoT SiteWise Monitor portals. 

// Example sending a request using ListPortalsRequest.
req := client.ListPortalsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListPortals

func (*Client) ListProjectAssetsRequest 

func (c *Client) ListProjectAssetsRequest(input *ListProjectAssetsInput) ListProjectAssetsRequest

ListProjectAssetsRequest returns a request value for making API operation for AWS IoT SiteWise.

Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project. 

// Example sending a request using ListProjectAssetsRequest.
req := client.ListProjectAssetsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListProjectAssets

func (*Client) ListProjectsRequest 

func (c *Client) ListProjectsRequest(input *ListProjectsInput) ListProjectsRequest

ListProjectsRequest returns a request value for making API operation for AWS IoT SiteWise.

Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal. 

// Example sending a request using ListProjectsRequest.
req := client.ListProjectsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListProjects

func (*Client) ListTagsForResourceRequest 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for AWS IoT SiteWise.

Retrieves the list of tags for an AWS IoT SiteWise resource. 

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListTagsForResource

func (*Client) PutLoggingOptionsRequest 

func (c *Client) PutLoggingOptionsRequest(input *PutLoggingOptionsInput) PutLoggingOptionsRequest

PutLoggingOptionsRequest returns a request value for making API operation for AWS IoT SiteWise.

Sets logging options for AWS IoT SiteWise. 

// Example sending a request using PutLoggingOptionsRequest.
req := client.PutLoggingOptionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/PutLoggingOptions

func (*Client) TagResourceRequest 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for AWS IoT SiteWise.

Adds tags to an AWS IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value. 

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/TagResource

func (*Client) UntagResourceRequest 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for AWS IoT SiteWise.

Removes a tag from an AWS IoT SiteWise resource. 

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UntagResource

func (*Client) UpdateAccessPolicyRequest 

func (c *Client) UpdateAccessPolicyRequest(input *UpdateAccessPolicyInput) UpdateAccessPolicyRequest

UpdateAccessPolicyRequest returns a request value for making API operation for AWS IoT SiteWise.

Updates an existing access policy that specifies an AWS SSO user or group's access to an AWS IoT SiteWise Monitor portal or project resource. 

// Example sending a request using UpdateAccessPolicyRequest.
req := client.UpdateAccessPolicyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateAccessPolicy

func (*Client) UpdateAssetModelRequest 

func (c *Client) UpdateAssetModelRequest(input *UpdateAssetModelInput) UpdateAssetModelRequest

UpdateAssetModelRequest returns a request value for making API operation for AWS IoT SiteWise.

Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating Assets and Models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html) in the AWS IoT SiteWise User Guide.

This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html).

If you remove a property from an asset model or update a property's formula expression, AWS IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, AWS IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property. 

// Example sending a request using UpdateAssetModelRequest.
req := client.UpdateAssetModelRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateAssetModel

func (*Client) UpdateAssetPropertyRequest 

func (c *Client) UpdateAssetPropertyRequest(input *UpdateAssetPropertyInput) UpdateAssetPropertyRequest

UpdateAssetPropertyRequest returns a request value for making API operation for AWS IoT SiteWise.

Updates an asset property's alias and notification state.

This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetProperty.html). 

// Example sending a request using UpdateAssetPropertyRequest.
req := client.UpdateAssetPropertyRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateAssetProperty

func (*Client) UpdateAssetRequest 

func (c *Client) UpdateAssetRequest(input *UpdateAssetInput) UpdateAssetRequest

UpdateAssetRequest returns a request value for making API operation for AWS IoT SiteWise.

Updates an asset's name. For more information, see Updating Assets and Models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html) in the AWS IoT SiteWise User Guide. 

// Example sending a request using UpdateAssetRequest.
req := client.UpdateAssetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateAsset

func (*Client) UpdateDashboardRequest 

func (c *Client) UpdateDashboardRequest(input *UpdateDashboardInput) UpdateDashboardRequest

UpdateDashboardRequest returns a request value for making API operation for AWS IoT SiteWise.

Updates an AWS IoT SiteWise Monitor dashboard. 

// Example sending a request using UpdateDashboardRequest.
req := client.UpdateDashboardRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateDashboard

func (*Client) UpdateGatewayCapabilityConfigurationRequest 

func (c *Client) UpdateGatewayCapabilityConfigurationRequest(input *UpdateGatewayCapabilityConfigurationInput) UpdateGatewayCapabilityConfigurationRequest

UpdateGatewayCapabilityConfigurationRequest returns a request value for making API operation for AWS IoT SiteWise.

Updates a gateway capability configuration or defines a new 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 AWS 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). 

// Example sending a request using UpdateGatewayCapabilityConfigurationRequest.
req := client.UpdateGatewayCapabilityConfigurationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateGatewayCapabilityConfiguration

func (*Client) UpdateGatewayRequest 

func (c *Client) UpdateGatewayRequest(input *UpdateGatewayInput) UpdateGatewayRequest

UpdateGatewayRequest returns a request value for making API operation for AWS IoT SiteWise.

Updates a gateway's name. 

// Example sending a request using UpdateGatewayRequest.
req := client.UpdateGatewayRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateGateway

func (*Client) UpdatePortalRequest 

func (c *Client) UpdatePortalRequest(input *UpdatePortalInput) UpdatePortalRequest

UpdatePortalRequest returns a request value for making API operation for AWS IoT SiteWise.

Updates an AWS IoT SiteWise Monitor portal. 

// Example sending a request using UpdatePortalRequest.
req := client.UpdatePortalRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdatePortal

func (*Client) UpdateProjectRequest 

func (c *Client) UpdateProjectRequest(input *UpdateProjectInput) UpdateProjectRequest

UpdateProjectRequest returns a request value for making API operation for AWS IoT SiteWise.

Updates an AWS IoT SiteWise Monitor project. 

// Example sending a request using UpdateProjectRequest.
req := client.UpdateProjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateProject

func (*Client) WaitUntilAssetActive 

func (c *Client) WaitUntilAssetActive(ctx context.Context, input *DescribeAssetInput, opts ...aws.WaiterOption) error

WaitUntilAssetActive uses the AWS IoT SiteWise API operation DescribeAsset to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

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 (*Client) WaitUntilAssetModelActive 

func (c *Client) WaitUntilAssetModelActive(ctx context.Context, input *DescribeAssetModelInput, opts ...aws.WaiterOption) error

WaitUntilAssetModelActive uses the AWS IoT SiteWise API operation DescribeAssetModel to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

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 (*Client) WaitUntilAssetModelNotExists 

func (c *Client) WaitUntilAssetModelNotExists(ctx context.Context, input *DescribeAssetModelInput, opts ...aws.WaiterOption) error

WaitUntilAssetModelNotExists uses the AWS IoT SiteWise API operation DescribeAssetModel to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

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 (*Client) WaitUntilAssetNotExists 

func (c *Client) WaitUntilAssetNotExists(ctx context.Context, input *DescribeAssetInput, opts ...aws.WaiterOption) error

WaitUntilAssetNotExists uses the AWS IoT SiteWise API operation DescribeAsset to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

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 (*Client) WaitUntilPortalActive 

func (c *Client) WaitUntilPortalActive(ctx context.Context, input *DescribePortalInput, opts ...aws.WaiterOption) error

WaitUntilPortalActive uses the AWS IoT SiteWise API operation DescribePortal to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

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 (*Client) WaitUntilPortalNotExists 

func (c *Client) WaitUntilPortalNotExists(ctx context.Context, input *DescribePortalInput, opts ...aws.WaiterOption) error

WaitUntilPortalNotExists uses the AWS IoT SiteWise API operation DescribePortal to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

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.

type CreateAccessPolicyInput 

type CreateAccessPolicyInput struct {

	// The identity for this access policy. Choose either a user or a group but
	// not both.
	//
	// 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 Permission `locationName:"accessPolicyPermission" type:"string" required:"true" enum:"true"`

	// The AWS IoT SiteWise Monitor resource for this access policy. Choose either
	// portal or project but not both.
	//
	// 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 AWS IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
	// in the AWS IoT SiteWise User Guide.
	Tags map[string]string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateAccessPolicyInput) MarshalFields 

func (s CreateAccessPolicyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateAccessPolicyInput) String 

func (s CreateAccessPolicyInput) String() string

String returns the string representation

func (*CreateAccessPolicyInput) Validate 

func (s *CreateAccessPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAccessPolicyOutput 

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 (CreateAccessPolicyOutput) MarshalFields 

func (s CreateAccessPolicyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateAccessPolicyOutput) String 

func (s CreateAccessPolicyOutput) String() string

String returns the string representation

type CreateAccessPolicyRequest 

type CreateAccessPolicyRequest struct {
	*aws.Request
	Input *CreateAccessPolicyInput
	Copy  func(*CreateAccessPolicyInput) CreateAccessPolicyRequest
}

CreateAccessPolicyRequest is the request type for the CreateAccessPolicy API operation.

func (CreateAccessPolicyRequest) Send 

func (r CreateAccessPolicyRequest) Send(ctx context.Context) (*CreateAccessPolicyResponse, error)

Send marshals and sends the CreateAccessPolicy API request.

type CreateAccessPolicyResponse 

type CreateAccessPolicyResponse struct {
	*CreateAccessPolicyOutput
	// contains filtered or unexported fields
}

CreateAccessPolicyResponse is the response type for the CreateAccessPolicy API operation.

func (*CreateAccessPolicyResponse) SDKResponseMetdata 

func (r *CreateAccessPolicyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateAccessPolicy request.

type CreateAssetInput 

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 AWS IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
	// in the AWS IoT SiteWise User Guide.
	Tags map[string]string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateAssetInput) MarshalFields 

func (s CreateAssetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateAssetInput) String 

func (s CreateAssetInput) String() string

String returns the string representation

func (*CreateAssetInput) Validate 

func (s *CreateAssetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAssetModelInput 

type CreateAssetModelInput struct {

	// 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 AWS 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 AWS 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 AWS 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 AWS 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 AWS IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
	// in the AWS IoT SiteWise User Guide.
	Tags map[string]string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateAssetModelInput) MarshalFields 

func (s CreateAssetModelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateAssetModelInput) String 

func (s CreateAssetModelInput) String() string

String returns the string representation

func (*CreateAssetModelInput) Validate 

func (s *CreateAssetModelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAssetModelOutput 

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 AWS 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 (CreateAssetModelOutput) MarshalFields 

func (s CreateAssetModelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateAssetModelOutput) String 

func (s CreateAssetModelOutput) String() string

String returns the string representation

type CreateAssetModelRequest 

type CreateAssetModelRequest struct {
	*aws.Request
	Input *CreateAssetModelInput
	Copy  func(*CreateAssetModelInput) CreateAssetModelRequest
}

CreateAssetModelRequest is the request type for the CreateAssetModel API operation.

func (CreateAssetModelRequest) Send 

func (r CreateAssetModelRequest) Send(ctx context.Context) (*CreateAssetModelResponse, error)

Send marshals and sends the CreateAssetModel API request.

type CreateAssetModelResponse 

type CreateAssetModelResponse struct {
	*CreateAssetModelOutput
	// contains filtered or unexported fields
}

CreateAssetModelResponse is the response type for the CreateAssetModel API operation.

func (*CreateAssetModelResponse) SDKResponseMetdata 

func (r *CreateAssetModelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateAssetModel request.

type CreateAssetOutput 

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 AWS IoT
	// SiteWise and can be used with other AWS 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 (CreateAssetOutput) MarshalFields 

func (s CreateAssetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateAssetOutput) String 

func (s CreateAssetOutput) String() string

String returns the string representation

type CreateAssetRequest 

type CreateAssetRequest struct {
	*aws.Request
	Input *CreateAssetInput
	Copy  func(*CreateAssetInput) CreateAssetRequest
}

CreateAssetRequest is the request type for the CreateAsset API operation.

func (CreateAssetRequest) Send 

func (r CreateAssetRequest) Send(ctx context.Context) (*CreateAssetResponse, error)

Send marshals and sends the CreateAsset API request.

type CreateAssetResponse 

type CreateAssetResponse struct {
	*CreateAssetOutput
	// contains filtered or unexported fields
}

CreateAssetResponse is the response type for the CreateAsset API operation.

func (*CreateAssetResponse) SDKResponseMetdata 

func (r *CreateAssetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateAsset request.

type CreateDashboardInput 

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 AWS 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 AWS IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
	// in the AWS IoT SiteWise User Guide.
	Tags map[string]string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateDashboardInput) MarshalFields 

func (s CreateDashboardInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateDashboardInput) String 

func (s CreateDashboardInput) String() string

String returns the string representation

func (*CreateDashboardInput) Validate 

func (s *CreateDashboardInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDashboardOutput 

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 (CreateDashboardOutput) MarshalFields 

func (s CreateDashboardOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateDashboardOutput) String 

func (s CreateDashboardOutput) String() string

String returns the string representation

type CreateDashboardRequest 

type CreateDashboardRequest struct {
	*aws.Request
	Input *CreateDashboardInput
	Copy  func(*CreateDashboardInput) CreateDashboardRequest
}

CreateDashboardRequest is the request type for the CreateDashboard API operation.

func (CreateDashboardRequest) Send 

func (r CreateDashboardRequest) Send(ctx context.Context) (*CreateDashboardResponse, error)

Send marshals and sends the CreateDashboard API request.

type CreateDashboardResponse 

type CreateDashboardResponse struct {
	*CreateDashboardOutput
	// contains filtered or unexported fields
}

CreateDashboardResponse is the response type for the CreateDashboard API operation.

func (*CreateDashboardResponse) SDKResponseMetdata 

func (r *CreateDashboardResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateDashboard request.

type CreateGatewayInput 

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 AWS IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
	// in the AWS IoT SiteWise User Guide.
	Tags map[string]string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateGatewayInput) MarshalFields 

func (s CreateGatewayInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateGatewayInput) String 

func (s CreateGatewayInput) String() string

String returns the string representation

func (*CreateGatewayInput) Validate 

func (s *CreateGatewayInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateGatewayOutput 

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 AWS
	// IoT SiteWise APIs.
	//
	// GatewayId is a required field
	GatewayId *string `locationName:"gatewayId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateGatewayOutput) MarshalFields 

func (s CreateGatewayOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateGatewayOutput) String 

func (s CreateGatewayOutput) String() string

String returns the string representation

type CreateGatewayRequest 

type CreateGatewayRequest struct {
	*aws.Request
	Input *CreateGatewayInput
	Copy  func(*CreateGatewayInput) CreateGatewayRequest
}

CreateGatewayRequest is the request type for the CreateGateway API operation.

func (CreateGatewayRequest) Send 

func (r CreateGatewayRequest) Send(ctx context.Context) (*CreateGatewayResponse, error)

Send marshals and sends the CreateGateway API request.

type CreateGatewayResponse 

type CreateGatewayResponse struct {
	*CreateGatewayOutput
	// contains filtered or unexported fields
}

CreateGatewayResponse is the response type for the CreateGateway API operation.

func (*CreateGatewayResponse) SDKResponseMetdata 

func (r *CreateGatewayResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateGateway request.

type CreatePortalInput 

type CreatePortalInput 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 AWS 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 AWS IoT SiteWise
	// resources on your behalf. For more information, see Using service roles for
	// AWS IoT SiteWise Monitor (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html)
	// in the AWS IoT SiteWise User Guide.
	//
	// RoleArn 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 AWS IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
	// in the AWS IoT SiteWise User Guide.
	Tags map[string]string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreatePortalInput) MarshalFields 

func (s CreatePortalInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreatePortalInput) String 

func (s CreatePortalInput) String() string

String returns the string representation

func (*CreatePortalInput) Validate 

func (s *CreatePortalInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreatePortalOutput 

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 public URL for the AWS IoT SiteWise Monitor 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 AWS SSO application Id.
	//
	// SsoApplicationId is a required field
	SsoApplicationId *string `locationName:"ssoApplicationId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreatePortalOutput) MarshalFields 

func (s CreatePortalOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreatePortalOutput) String 

func (s CreatePortalOutput) String() string

String returns the string representation

type CreatePortalRequest 

type CreatePortalRequest struct {
	*aws.Request
	Input *CreatePortalInput
	Copy  func(*CreatePortalInput) CreatePortalRequest
}

CreatePortalRequest is the request type for the CreatePortal API operation.

func (CreatePortalRequest) Send 

func (r CreatePortalRequest) Send(ctx context.Context) (*CreatePortalResponse, error)

Send marshals and sends the CreatePortal API request.

type CreatePortalResponse 

type CreatePortalResponse struct {
	*CreatePortalOutput
	// contains filtered or unexported fields
}

CreatePortalResponse is the response type for the CreatePortal API operation.

func (*CreatePortalResponse) SDKResponseMetdata 

func (r *CreatePortalResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreatePortal request.

type CreateProjectInput 

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 AWS IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
	// in the AWS IoT SiteWise User Guide.
	Tags map[string]string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateProjectInput) MarshalFields 

func (s CreateProjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateProjectInput) String 

func (s CreateProjectInput) String() string

String returns the string representation

func (*CreateProjectInput) Validate 

func (s *CreateProjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateProjectOutput 

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 (CreateProjectOutput) MarshalFields 

func (s CreateProjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateProjectOutput) String 

func (s CreateProjectOutput) String() string

String returns the string representation

type CreateProjectRequest 

type CreateProjectRequest struct {
	*aws.Request
	Input *CreateProjectInput
	Copy  func(*CreateProjectInput) CreateProjectRequest
}

CreateProjectRequest is the request type for the CreateProject API operation.

func (CreateProjectRequest) Send 

func (r CreateProjectRequest) Send(ctx context.Context) (*CreateProjectResponse, error)

Send marshals and sends the CreateProject API request.

type CreateProjectResponse 

type CreateProjectResponse struct {
	*CreateProjectOutput
	// contains filtered or unexported fields
}

CreateProjectResponse is the response type for the CreateProject API operation.

func (*CreateProjectResponse) SDKResponseMetdata 

func (r *CreateProjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateProject request.

type DashboardSummary 

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 (DashboardSummary) MarshalFields 

func (s DashboardSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DashboardSummary) String 

func (s DashboardSummary) String() string

String returns the string representation

type DeleteAccessPolicyInput 

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 (DeleteAccessPolicyInput) MarshalFields 

func (s DeleteAccessPolicyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteAccessPolicyInput) String 

func (s DeleteAccessPolicyInput) String() string

String returns the string representation

func (*DeleteAccessPolicyInput) Validate 

func (s *DeleteAccessPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAccessPolicyOutput 

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

func (DeleteAccessPolicyOutput) MarshalFields 

func (s DeleteAccessPolicyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteAccessPolicyOutput) String 

func (s DeleteAccessPolicyOutput) String() string

String returns the string representation

type DeleteAccessPolicyRequest 

type DeleteAccessPolicyRequest struct {
	*aws.Request
	Input *DeleteAccessPolicyInput
	Copy  func(*DeleteAccessPolicyInput) DeleteAccessPolicyRequest
}

DeleteAccessPolicyRequest is the request type for the DeleteAccessPolicy API operation.

func (DeleteAccessPolicyRequest) Send 

func (r DeleteAccessPolicyRequest) Send(ctx context.Context) (*DeleteAccessPolicyResponse, error)

Send marshals and sends the DeleteAccessPolicy API request.

type DeleteAccessPolicyResponse 

type DeleteAccessPolicyResponse struct {
	*DeleteAccessPolicyOutput
	// contains filtered or unexported fields
}

DeleteAccessPolicyResponse is the response type for the DeleteAccessPolicy API operation.

func (*DeleteAccessPolicyResponse) SDKResponseMetdata 

func (r *DeleteAccessPolicyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteAccessPolicy request.

type DeleteAssetInput 

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 (DeleteAssetInput) MarshalFields 

func (s DeleteAssetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteAssetInput) String 

func (s DeleteAssetInput) String() string

String returns the string representation

func (*DeleteAssetInput) Validate 

func (s *DeleteAssetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAssetModelInput 

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 (DeleteAssetModelInput) MarshalFields 

func (s DeleteAssetModelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteAssetModelInput) String 

func (s DeleteAssetModelInput) String() string

String returns the string representation

func (*DeleteAssetModelInput) Validate 

func (s *DeleteAssetModelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAssetModelOutput 

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 (DeleteAssetModelOutput) MarshalFields 

func (s DeleteAssetModelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteAssetModelOutput) String 

func (s DeleteAssetModelOutput) String() string

String returns the string representation

type DeleteAssetModelRequest 

type DeleteAssetModelRequest struct {
	*aws.Request
	Input *DeleteAssetModelInput
	Copy  func(*DeleteAssetModelInput) DeleteAssetModelRequest
}

DeleteAssetModelRequest is the request type for the DeleteAssetModel API operation.

func (DeleteAssetModelRequest) Send 

func (r DeleteAssetModelRequest) Send(ctx context.Context) (*DeleteAssetModelResponse, error)

Send marshals and sends the DeleteAssetModel API request.

type DeleteAssetModelResponse 

type DeleteAssetModelResponse struct {
	*DeleteAssetModelOutput
	// contains filtered or unexported fields
}

DeleteAssetModelResponse is the response type for the DeleteAssetModel API operation.

func (*DeleteAssetModelResponse) SDKResponseMetdata 

func (r *DeleteAssetModelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteAssetModel request.

type DeleteAssetOutput 

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 (DeleteAssetOutput) MarshalFields 

func (s DeleteAssetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteAssetOutput) String 

func (s DeleteAssetOutput) String() string

String returns the string representation

type DeleteAssetRequest 

type DeleteAssetRequest struct {
	*aws.Request
	Input *DeleteAssetInput
	Copy  func(*DeleteAssetInput) DeleteAssetRequest
}

DeleteAssetRequest is the request type for the DeleteAsset API operation.

func (DeleteAssetRequest) Send 

func (r DeleteAssetRequest) Send(ctx context.Context) (*DeleteAssetResponse, error)

Send marshals and sends the DeleteAsset API request.

type DeleteAssetResponse 

type DeleteAssetResponse struct {
	*DeleteAssetOutput
	// contains filtered or unexported fields
}

DeleteAssetResponse is the response type for the DeleteAsset API operation.

func (*DeleteAssetResponse) SDKResponseMetdata 

func (r *DeleteAssetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteAsset request.

type DeleteDashboardInput 

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 (DeleteDashboardInput) MarshalFields 

func (s DeleteDashboardInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteDashboardInput) String 

func (s DeleteDashboardInput) String() string

String returns the string representation

func (*DeleteDashboardInput) Validate 

func (s *DeleteDashboardInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDashboardOutput 

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

func (DeleteDashboardOutput) MarshalFields 

func (s DeleteDashboardOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteDashboardOutput) String 

func (s DeleteDashboardOutput) String() string

String returns the string representation

type DeleteDashboardRequest 

type DeleteDashboardRequest struct {
	*aws.Request
	Input *DeleteDashboardInput
	Copy  func(*DeleteDashboardInput) DeleteDashboardRequest
}

DeleteDashboardRequest is the request type for the DeleteDashboard API operation.

func (DeleteDashboardRequest) Send 

func (r DeleteDashboardRequest) Send(ctx context.Context) (*DeleteDashboardResponse, error)

Send marshals and sends the DeleteDashboard API request.

type DeleteDashboardResponse 

type DeleteDashboardResponse struct {
	*DeleteDashboardOutput
	// contains filtered or unexported fields
}

DeleteDashboardResponse is the response type for the DeleteDashboard API operation.

func (*DeleteDashboardResponse) SDKResponseMetdata 

func (r *DeleteDashboardResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteDashboard request.

type DeleteGatewayInput 

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 (DeleteGatewayInput) MarshalFields 

func (s DeleteGatewayInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteGatewayInput) String 

func (s DeleteGatewayInput) String() string

String returns the string representation

func (*DeleteGatewayInput) Validate 

func (s *DeleteGatewayInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteGatewayOutput 

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

func (DeleteGatewayOutput) MarshalFields 

func (s DeleteGatewayOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteGatewayOutput) String 

func (s DeleteGatewayOutput) String() string

String returns the string representation

type DeleteGatewayRequest 

type DeleteGatewayRequest struct {
	*aws.Request
	Input *DeleteGatewayInput
	Copy  func(*DeleteGatewayInput) DeleteGatewayRequest
}

DeleteGatewayRequest is the request type for the DeleteGateway API operation.

func (DeleteGatewayRequest) Send 

func (r DeleteGatewayRequest) Send(ctx context.Context) (*DeleteGatewayResponse, error)

Send marshals and sends the DeleteGateway API request.

type DeleteGatewayResponse 

type DeleteGatewayResponse struct {
	*DeleteGatewayOutput
	// contains filtered or unexported fields
}

DeleteGatewayResponse is the response type for the DeleteGateway API operation.

func (*DeleteGatewayResponse) SDKResponseMetdata 

func (r *DeleteGatewayResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteGateway request.

type DeletePortalInput 

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 (DeletePortalInput) MarshalFields 

func (s DeletePortalInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeletePortalInput) String 

func (s DeletePortalInput) String() string

String returns the string representation

func (*DeletePortalInput) Validate 

func (s *DeletePortalInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeletePortalOutput 

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 (DeletePortalOutput) MarshalFields 

func (s DeletePortalOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeletePortalOutput) String 

func (s DeletePortalOutput) String() string

String returns the string representation

type DeletePortalRequest 

type DeletePortalRequest struct {
	*aws.Request
	Input *DeletePortalInput
	Copy  func(*DeletePortalInput) DeletePortalRequest
}

DeletePortalRequest is the request type for the DeletePortal API operation.

func (DeletePortalRequest) Send 

func (r DeletePortalRequest) Send(ctx context.Context) (*DeletePortalResponse, error)

Send marshals and sends the DeletePortal API request.

type DeletePortalResponse 

type DeletePortalResponse struct {
	*DeletePortalOutput
	// contains filtered or unexported fields
}

DeletePortalResponse is the response type for the DeletePortal API operation.

func (*DeletePortalResponse) SDKResponseMetdata 

func (r *DeletePortalResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeletePortal request.

type DeleteProjectInput 

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 (DeleteProjectInput) MarshalFields 

func (s DeleteProjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteProjectInput) String 

func (s DeleteProjectInput) String() string

String returns the string representation

func (*DeleteProjectInput) Validate 

func (s *DeleteProjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteProjectOutput 

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

func (DeleteProjectOutput) MarshalFields 

func (s DeleteProjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteProjectOutput) String 

func (s DeleteProjectOutput) String() string

String returns the string representation

type DeleteProjectRequest 

type DeleteProjectRequest struct {
	*aws.Request
	Input *DeleteProjectInput
	Copy  func(*DeleteProjectInput) DeleteProjectRequest
}

DeleteProjectRequest is the request type for the DeleteProject API operation.

func (DeleteProjectRequest) Send 

func (r DeleteProjectRequest) Send(ctx context.Context) (*DeleteProjectResponse, error)

Send marshals and sends the DeleteProject API request.

type DeleteProjectResponse 

type DeleteProjectResponse struct {
	*DeleteProjectOutput
	// contains filtered or unexported fields
}

DeleteProjectResponse is the response type for the DeleteProject API operation.

func (*DeleteProjectResponse) SDKResponseMetdata 

func (r *DeleteProjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteProject request.

type DescribeAccessPolicyInput 

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 (DescribeAccessPolicyInput) MarshalFields 

func (s DescribeAccessPolicyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeAccessPolicyInput) String 

func (s DescribeAccessPolicyInput) String() string

String returns the string representation

func (*DescribeAccessPolicyInput) Validate 

func (s *DescribeAccessPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAccessPolicyOutput 

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 AWS SSO identity (user or group) 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 Permission `locationName:"accessPolicyPermission" type:"string" required:"true" enum:"true"`

	// The AWS 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 (DescribeAccessPolicyOutput) MarshalFields 

func (s DescribeAccessPolicyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeAccessPolicyOutput) String 

func (s DescribeAccessPolicyOutput) String() string

String returns the string representation

type DescribeAccessPolicyRequest 

type DescribeAccessPolicyRequest struct {
	*aws.Request
	Input *DescribeAccessPolicyInput
	Copy  func(*DescribeAccessPolicyInput) DescribeAccessPolicyRequest
}

DescribeAccessPolicyRequest is the request type for the DescribeAccessPolicy API operation.

func (DescribeAccessPolicyRequest) Send 

func (r DescribeAccessPolicyRequest) Send(ctx context.Context) (*DescribeAccessPolicyResponse, error)

Send marshals and sends the DescribeAccessPolicy API request.

type DescribeAccessPolicyResponse 

type DescribeAccessPolicyResponse struct {
	*DescribeAccessPolicyOutput
	// contains filtered or unexported fields
}

DescribeAccessPolicyResponse is the response type for the DescribeAccessPolicy API operation.

func (*DescribeAccessPolicyResponse) SDKResponseMetdata 

func (r *DescribeAccessPolicyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeAccessPolicy request.

type DescribeAssetInput 

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 (DescribeAssetInput) MarshalFields 

func (s DescribeAssetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeAssetInput) String 

func (s DescribeAssetInput) String() string

String returns the string representation

func (*DescribeAssetInput) Validate 

func (s *DescribeAssetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAssetModelInput 

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 (DescribeAssetModelInput) MarshalFields 

func (s DescribeAssetModelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeAssetModelInput) String 

func (s DescribeAssetModelInput) String() string

String returns the string representation

func (*DescribeAssetModelInput) Validate 

func (s *DescribeAssetModelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAssetModelOutput 

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 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.
	//
	// 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 (DescribeAssetModelOutput) MarshalFields 

func (s DescribeAssetModelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeAssetModelOutput) String 

func (s DescribeAssetModelOutput) String() string

String returns the string representation

type DescribeAssetModelRequest 

type DescribeAssetModelRequest struct {
	*aws.Request
	Input *DescribeAssetModelInput
	Copy  func(*DescribeAssetModelInput) DescribeAssetModelRequest
}

DescribeAssetModelRequest is the request type for the DescribeAssetModel API operation.

func (DescribeAssetModelRequest) Send 

func (r DescribeAssetModelRequest) Send(ctx context.Context) (*DescribeAssetModelResponse, error)

Send marshals and sends the DescribeAssetModel API request.

type DescribeAssetModelResponse 

type DescribeAssetModelResponse struct {
	*DescribeAssetModelOutput
	// contains filtered or unexported fields
}

DescribeAssetModelResponse is the response type for the DescribeAssetModel API operation.

func (*DescribeAssetModelResponse) SDKResponseMetdata 

func (r *DescribeAssetModelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeAssetModel request.

type DescribeAssetOutput 

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 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.
	//
	// 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 (DescribeAssetOutput) MarshalFields 

func (s DescribeAssetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeAssetOutput) String 

func (s DescribeAssetOutput) String() string

String returns the string representation

type DescribeAssetPropertyInput 

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 (DescribeAssetPropertyInput) MarshalFields 

func (s DescribeAssetPropertyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeAssetPropertyInput) String 

func (s DescribeAssetPropertyInput) String() string

String returns the string representation

func (*DescribeAssetPropertyInput) Validate 

func (s *DescribeAssetPropertyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAssetPropertyOutput 

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.
	//
	// AssetProperty is a required field
	AssetProperty *Property `locationName:"assetProperty" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAssetPropertyOutput) MarshalFields 

func (s DescribeAssetPropertyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeAssetPropertyOutput) String 

func (s DescribeAssetPropertyOutput) String() string

String returns the string representation

type DescribeAssetPropertyRequest 

type DescribeAssetPropertyRequest struct {
	*aws.Request
	Input *DescribeAssetPropertyInput
	Copy  func(*DescribeAssetPropertyInput) DescribeAssetPropertyRequest
}

DescribeAssetPropertyRequest is the request type for the DescribeAssetProperty API operation.

func (DescribeAssetPropertyRequest) Send 

func (r DescribeAssetPropertyRequest) Send(ctx context.Context) (*DescribeAssetPropertyResponse, error)

Send marshals and sends the DescribeAssetProperty API request.

type DescribeAssetPropertyResponse 

type DescribeAssetPropertyResponse struct {
	*DescribeAssetPropertyOutput
	// contains filtered or unexported fields
}

DescribeAssetPropertyResponse is the response type for the DescribeAssetProperty API operation.

func (*DescribeAssetPropertyResponse) SDKResponseMetdata 

func (r *DescribeAssetPropertyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeAssetProperty request.

type DescribeAssetRequest 

type DescribeAssetRequest struct {
	*aws.Request
	Input *DescribeAssetInput
	Copy  func(*DescribeAssetInput) DescribeAssetRequest
}

DescribeAssetRequest is the request type for the DescribeAsset API operation.

func (DescribeAssetRequest) Send 

func (r DescribeAssetRequest) Send(ctx context.Context) (*DescribeAssetResponse, error)

Send marshals and sends the DescribeAsset API request.

type DescribeAssetResponse 

type DescribeAssetResponse struct {
	*DescribeAssetOutput
	// contains filtered or unexported fields
}

DescribeAssetResponse is the response type for the DescribeAsset API operation.

func (*DescribeAssetResponse) SDKResponseMetdata 

func (r *DescribeAssetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeAsset request.

type DescribeDashboardInput 

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 (DescribeDashboardInput) MarshalFields 

func (s DescribeDashboardInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeDashboardInput) String 

func (s DescribeDashboardInput) String() string

String returns the string representation

func (*DescribeDashboardInput) Validate 

func (s *DescribeDashboardInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeDashboardOutput 

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 AWS 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 (DescribeDashboardOutput) MarshalFields 

func (s DescribeDashboardOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeDashboardOutput) String 

func (s DescribeDashboardOutput) String() string

String returns the string representation

type DescribeDashboardRequest 

type DescribeDashboardRequest struct {
	*aws.Request
	Input *DescribeDashboardInput
	Copy  func(*DescribeDashboardInput) DescribeDashboardRequest
}

DescribeDashboardRequest is the request type for the DescribeDashboard API operation.

func (DescribeDashboardRequest) Send 

func (r DescribeDashboardRequest) Send(ctx context.Context) (*DescribeDashboardResponse, error)

Send marshals and sends the DescribeDashboard API request.

type DescribeDashboardResponse 

type DescribeDashboardResponse struct {
	*DescribeDashboardOutput
	// contains filtered or unexported fields
}

DescribeDashboardResponse is the response type for the DescribeDashboard API operation.

func (*DescribeDashboardResponse) SDKResponseMetdata 

func (r *DescribeDashboardResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDashboard request.

type DescribeGatewayCapabilityConfigurationInput 

type DescribeGatewayCapabilityConfigurationInput struct {

	// The namespace of the capability configuration. For example, if you configure
	// OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability
	// configuration has the namespace iotsitewise:opcuacollector:version, where
	// version is a number such as 1.
	//
	// CapabilityNamespace 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 (DescribeGatewayCapabilityConfigurationInput) MarshalFields 

func (s DescribeGatewayCapabilityConfigurationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeGatewayCapabilityConfigurationInput) String 

func (s DescribeGatewayCapabilityConfigurationInput) String() string

String returns the string representation

func (*DescribeGatewayCapabilityConfigurationInput) Validate 

func (s *DescribeGatewayCapabilityConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeGatewayCapabilityConfigurationOutput 

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 AWS 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 CapabilitySyncStatus `locationName:"capabilitySyncStatus" type:"string" required:"true" enum:"true"`

	// 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 (DescribeGatewayCapabilityConfigurationOutput) MarshalFields 

func (s DescribeGatewayCapabilityConfigurationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeGatewayCapabilityConfigurationOutput) String 

func (s DescribeGatewayCapabilityConfigurationOutput) String() string

String returns the string representation

type DescribeGatewayCapabilityConfigurationRequest 

type DescribeGatewayCapabilityConfigurationRequest struct {
	*aws.Request
	Input *DescribeGatewayCapabilityConfigurationInput
	Copy  func(*DescribeGatewayCapabilityConfigurationInput) DescribeGatewayCapabilityConfigurationRequest
}

DescribeGatewayCapabilityConfigurationRequest is the request type for the DescribeGatewayCapabilityConfiguration API operation.

func (DescribeGatewayCapabilityConfigurationRequest) Send 

func (r DescribeGatewayCapabilityConfigurationRequest) Send(ctx context.Context) (*DescribeGatewayCapabilityConfigurationResponse, error)

Send marshals and sends the DescribeGatewayCapabilityConfiguration API request.

type DescribeGatewayCapabilityConfigurationResponse 

type DescribeGatewayCapabilityConfigurationResponse struct {
	*DescribeGatewayCapabilityConfigurationOutput
	// contains filtered or unexported fields
}

DescribeGatewayCapabilityConfigurationResponse is the response type for the DescribeGatewayCapabilityConfiguration API operation.

func (*DescribeGatewayCapabilityConfigurationResponse) SDKResponseMetdata 

func (r *DescribeGatewayCapabilityConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeGatewayCapabilityConfiguration request.

type DescribeGatewayInput 

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 (DescribeGatewayInput) MarshalFields 

func (s DescribeGatewayInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeGatewayInput) String 

func (s DescribeGatewayInput) String() string

String returns the string representation

func (*DescribeGatewayInput) Validate 

func (s *DescribeGatewayInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeGatewayOutput 

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 (DescribeGatewayOutput) MarshalFields 

func (s DescribeGatewayOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeGatewayOutput) String 

func (s DescribeGatewayOutput) String() string

String returns the string representation

type DescribeGatewayRequest 

type DescribeGatewayRequest struct {
	*aws.Request
	Input *DescribeGatewayInput
	Copy  func(*DescribeGatewayInput) DescribeGatewayRequest
}

DescribeGatewayRequest is the request type for the DescribeGateway API operation.

func (DescribeGatewayRequest) Send 

func (r DescribeGatewayRequest) Send(ctx context.Context) (*DescribeGatewayResponse, error)

Send marshals and sends the DescribeGateway API request.

type DescribeGatewayResponse 

type DescribeGatewayResponse struct {
	*DescribeGatewayOutput
	// contains filtered or unexported fields
}

DescribeGatewayResponse is the response type for the DescribeGateway API operation.

func (*DescribeGatewayResponse) SDKResponseMetdata 

func (r *DescribeGatewayResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeGateway request.

type DescribeLoggingOptionsInput 

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

func (DescribeLoggingOptionsInput) MarshalFields 

func (s DescribeLoggingOptionsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeLoggingOptionsInput) String 

func (s DescribeLoggingOptionsInput) String() string

String returns the string representation

type DescribeLoggingOptionsOutput 

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 (DescribeLoggingOptionsOutput) MarshalFields 

func (s DescribeLoggingOptionsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeLoggingOptionsOutput) String 

func (s DescribeLoggingOptionsOutput) String() string

String returns the string representation

type DescribeLoggingOptionsRequest 

type DescribeLoggingOptionsRequest struct {
	*aws.Request
	Input *DescribeLoggingOptionsInput
	Copy  func(*DescribeLoggingOptionsInput) DescribeLoggingOptionsRequest
}

DescribeLoggingOptionsRequest is the request type for the DescribeLoggingOptions API operation.

func (DescribeLoggingOptionsRequest) Send 

func (r DescribeLoggingOptionsRequest) Send(ctx context.Context) (*DescribeLoggingOptionsResponse, error)

Send marshals and sends the DescribeLoggingOptions API request.

type DescribeLoggingOptionsResponse 

type DescribeLoggingOptionsResponse struct {
	*DescribeLoggingOptionsOutput
	// contains filtered or unexported fields
}

DescribeLoggingOptionsResponse is the response type for the DescribeLoggingOptions API operation.

func (*DescribeLoggingOptionsResponse) SDKResponseMetdata 

func (r *DescribeLoggingOptionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeLoggingOptions request.

type DescribePortalInput 

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 (DescribePortalInput) MarshalFields 

func (s DescribePortalInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribePortalInput) String 

func (s DescribePortalInput) String() string

String returns the string representation

func (*DescribePortalInput) Validate 

func (s *DescribePortalInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribePortalOutput 

type DescribePortalOutput 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 AWS SSO application generated client ID (used with AWS SSO APIs).
	//
	// PortalClientId is a required field
	PortalClientId *string `locationName:"portalClientId" min:"1" type:"string" required:"true"`

	// The AWS 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 public root URL for the AWS IoT AWS IoT SiteWise Monitor application
	// 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 AWS IoT
	// SiteWise resources on your behalf. For more information, see Using service
	// roles for AWS IoT SiteWise Monitor (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html)
	// in the AWS IoT SiteWise User Guide.
	RoleArn *string `locationName:"roleArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribePortalOutput) MarshalFields 

func (s DescribePortalOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribePortalOutput) String 

func (s DescribePortalOutput) String() string

String returns the string representation

type DescribePortalRequest 

type DescribePortalRequest struct {
	*aws.Request
	Input *DescribePortalInput
	Copy  func(*DescribePortalInput) DescribePortalRequest
}

DescribePortalRequest is the request type for the DescribePortal API operation.

func (DescribePortalRequest) Send 

func (r DescribePortalRequest) Send(ctx context.Context) (*DescribePortalResponse, error)

Send marshals and sends the DescribePortal API request.

type DescribePortalResponse 

type DescribePortalResponse struct {
	*DescribePortalOutput
	// contains filtered or unexported fields
}

DescribePortalResponse is the response type for the DescribePortal API operation.

func (*DescribePortalResponse) SDKResponseMetdata 

func (r *DescribePortalResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribePortal request.

type DescribeProjectInput 

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 (DescribeProjectInput) MarshalFields 

func (s DescribeProjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeProjectInput) String 

func (s DescribeProjectInput) String() string

String returns the string representation

func (*DescribeProjectInput) Validate 

func (s *DescribeProjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeProjectOutput 

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 (DescribeProjectOutput) MarshalFields 

func (s DescribeProjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeProjectOutput) String 

func (s DescribeProjectOutput) String() string

String returns the string representation

type DescribeProjectRequest 

type DescribeProjectRequest struct {
	*aws.Request
	Input *DescribeProjectInput
	Copy  func(*DescribeProjectInput) DescribeProjectRequest
}

DescribeProjectRequest is the request type for the DescribeProject API operation.

func (DescribeProjectRequest) Send 

func (r DescribeProjectRequest) Send(ctx context.Context) (*DescribeProjectResponse, error)

Send marshals and sends the DescribeProject API request.

type DescribeProjectResponse 

type DescribeProjectResponse struct {
	*DescribeProjectOutput
	// contains filtered or unexported fields
}

DescribeProjectResponse is the response type for the DescribeProject API operation.

func (*DescribeProjectResponse) SDKResponseMetdata 

func (r *DescribeProjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeProject request.

type DisassociateAssetsInput 

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 AWS 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 (DisassociateAssetsInput) MarshalFields 

func (s DisassociateAssetsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DisassociateAssetsInput) String 

func (s DisassociateAssetsInput) String() string

String returns the string representation

func (*DisassociateAssetsInput) Validate 

func (s *DisassociateAssetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateAssetsOutput 

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

func (DisassociateAssetsOutput) MarshalFields 

func (s DisassociateAssetsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DisassociateAssetsOutput) String 

func (s DisassociateAssetsOutput) String() string

String returns the string representation

type DisassociateAssetsRequest 

type DisassociateAssetsRequest struct {
	*aws.Request
	Input *DisassociateAssetsInput
	Copy  func(*DisassociateAssetsInput) DisassociateAssetsRequest
}

DisassociateAssetsRequest is the request type for the DisassociateAssets API operation.

func (DisassociateAssetsRequest) Send 

func (r DisassociateAssetsRequest) Send(ctx context.Context) (*DisassociateAssetsResponse, error)

Send marshals and sends the DisassociateAssets API request.

type DisassociateAssetsResponse 

type DisassociateAssetsResponse struct {
	*DisassociateAssetsOutput
	// contains filtered or unexported fields
}

DisassociateAssetsResponse is the response type for the DisassociateAssets API operation.

func (*DisassociateAssetsResponse) SDKResponseMetdata 

func (r *DisassociateAssetsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DisassociateAssets request.

type ErrorCode 

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

Enum values for ErrorCode

func (ErrorCode) MarshalValue 

func (enum ErrorCode) MarshalValue() (string, error)

func (ErrorCode) MarshalValueBuf 

func (enum ErrorCode) MarshalValueBuf(b []byte) ([]byte, error)

type ErrorDetails 

type ErrorDetails struct {

	// The error code.
	//
	// Code is a required field
	Code ErrorCode `locationName:"code" type:"string" required:"true" enum:"true"`

	// 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 AWS IoT SiteWise error.

func (ErrorDetails) MarshalFields 

func (s ErrorDetails) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ErrorDetails) String 

func (s ErrorDetails) String() string

String returns the string representation

type ExpressionVariable 

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 (ExpressionVariable) MarshalFields 

func (s ExpressionVariable) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ExpressionVariable) String 

func (s ExpressionVariable) String() string

String returns the string representation

func (*ExpressionVariable) Validate 

func (s *ExpressionVariable) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GatewayCapabilitySummary 

type GatewayCapabilitySummary struct {

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

Contains a summary of a gateway capability configuration.

func (GatewayCapabilitySummary) MarshalFields 

func (s GatewayCapabilitySummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GatewayCapabilitySummary) String 

func (s GatewayCapabilitySummary) String() string

String returns the string representation

type GatewayPlatform 

type GatewayPlatform struct {

	// A gateway that runs on AWS IoT Greengrass.
	//
	// Greengrass is a required field
	Greengrass *Greengrass `locationName:"greengrass" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains a gateway's platform information.

func (GatewayPlatform) MarshalFields 

func (s GatewayPlatform) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GatewayPlatform) String 

func (s GatewayPlatform) String() string

String returns the string representation

func (*GatewayPlatform) Validate 

func (s *GatewayPlatform) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GatewaySummary 

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"`

	// 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 (GatewaySummary) MarshalFields 

func (s GatewaySummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GatewaySummary) String 

func (s GatewaySummary) String() string

String returns the string representation

type GetAssetPropertyAggregatesInput 

type GetAssetPropertyAggregatesInput struct {

	// The data aggregating function.
	//
	// AggregateTypes is a required field
	AggregateTypes []AggregateType `location:"querystring" locationName:"aggregateTypes" min:"1" type:"list" required:"true"`

	// 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 be returned per paginated request.
	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 property alias that identifies the property, such as an OPC-UA server
	// data stream path (for example, /company/windfarm/3/turbine/7/temperature).
	// For more information, see Mapping Industrial Data Streams to Asset Properties
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the AWS IoT SiteWise User Guide.
	PropertyAlias *string `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 []Quality `location:"querystring" locationName:"qualities" min:"1" type:"list"`

	// 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.
	TimeOrdering TimeOrdering `location:"querystring" locationName:"timeOrdering" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (GetAssetPropertyAggregatesInput) MarshalFields 

func (s GetAssetPropertyAggregatesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetAssetPropertyAggregatesInput) String 

func (s GetAssetPropertyAggregatesInput) String() string

String returns the string representation

func (*GetAssetPropertyAggregatesInput) Validate 

func (s *GetAssetPropertyAggregatesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAssetPropertyAggregatesOutput 

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 (GetAssetPropertyAggregatesOutput) MarshalFields 

func (s GetAssetPropertyAggregatesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetAssetPropertyAggregatesOutput) String 

func (s GetAssetPropertyAggregatesOutput) String() string

String returns the string representation

type GetAssetPropertyAggregatesPaginator 

type GetAssetPropertyAggregatesPaginator struct {
	aws.Pager
}

GetAssetPropertyAggregatesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetAssetPropertyAggregatesPaginator 

func NewGetAssetPropertyAggregatesPaginator(req GetAssetPropertyAggregatesRequest) GetAssetPropertyAggregatesPaginator

NewGetAssetPropertyAggregatesRequestPaginator returns a paginator for GetAssetPropertyAggregates. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.GetAssetPropertyAggregatesRequest(input)
p := iotsitewise.NewGetAssetPropertyAggregatesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetAssetPropertyAggregatesPaginator) CurrentPage 

func (p *GetAssetPropertyAggregatesPaginator) CurrentPage() *GetAssetPropertyAggregatesOutput

type GetAssetPropertyAggregatesRequest 

type GetAssetPropertyAggregatesRequest struct {
	*aws.Request
	Input *GetAssetPropertyAggregatesInput
	Copy  func(*GetAssetPropertyAggregatesInput) GetAssetPropertyAggregatesRequest
}

GetAssetPropertyAggregatesRequest is the request type for the GetAssetPropertyAggregates API operation.

func (GetAssetPropertyAggregatesRequest) Send 

func (r GetAssetPropertyAggregatesRequest) Send(ctx context.Context) (*GetAssetPropertyAggregatesResponse, error)

Send marshals and sends the GetAssetPropertyAggregates API request.

type GetAssetPropertyAggregatesResponse 

type GetAssetPropertyAggregatesResponse struct {
	*GetAssetPropertyAggregatesOutput
	// contains filtered or unexported fields
}

GetAssetPropertyAggregatesResponse is the response type for the GetAssetPropertyAggregates API operation.

func (*GetAssetPropertyAggregatesResponse) SDKResponseMetdata 

func (r *GetAssetPropertyAggregatesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetAssetPropertyAggregates request.

type GetAssetPropertyValueHistoryInput 

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 be returned per paginated request.
	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 property alias that identifies the property, such as an OPC-UA server
	// data stream path (for example, /company/windfarm/3/turbine/7/temperature).
	// For more information, see Mapping Industrial Data Streams to Asset Properties
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the AWS IoT SiteWise User Guide.
	PropertyAlias *string `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 []Quality `location:"querystring" locationName:"qualities" min:"1" type:"list"`

	// 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.
	TimeOrdering TimeOrdering `location:"querystring" locationName:"timeOrdering" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (GetAssetPropertyValueHistoryInput) MarshalFields 

func (s GetAssetPropertyValueHistoryInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetAssetPropertyValueHistoryInput) String 

func (s GetAssetPropertyValueHistoryInput) String() string

String returns the string representation

func (*GetAssetPropertyValueHistoryInput) Validate 

func (s *GetAssetPropertyValueHistoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAssetPropertyValueHistoryOutput 

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 (GetAssetPropertyValueHistoryOutput) MarshalFields 

func (s GetAssetPropertyValueHistoryOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetAssetPropertyValueHistoryOutput) String 

func (s GetAssetPropertyValueHistoryOutput) String() string

String returns the string representation

type GetAssetPropertyValueHistoryPaginator 

type GetAssetPropertyValueHistoryPaginator struct {
	aws.Pager
}

GetAssetPropertyValueHistoryPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewGetAssetPropertyValueHistoryPaginator 

func NewGetAssetPropertyValueHistoryPaginator(req GetAssetPropertyValueHistoryRequest) GetAssetPropertyValueHistoryPaginator

NewGetAssetPropertyValueHistoryRequestPaginator returns a paginator for GetAssetPropertyValueHistory. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.GetAssetPropertyValueHistoryRequest(input)
p := iotsitewise.NewGetAssetPropertyValueHistoryRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*GetAssetPropertyValueHistoryPaginator) CurrentPage 

func (p *GetAssetPropertyValueHistoryPaginator) CurrentPage() *GetAssetPropertyValueHistoryOutput

type GetAssetPropertyValueHistoryRequest 

type GetAssetPropertyValueHistoryRequest struct {
	*aws.Request
	Input *GetAssetPropertyValueHistoryInput
	Copy  func(*GetAssetPropertyValueHistoryInput) GetAssetPropertyValueHistoryRequest
}

GetAssetPropertyValueHistoryRequest is the request type for the GetAssetPropertyValueHistory API operation.

func (GetAssetPropertyValueHistoryRequest) Send 

func (r GetAssetPropertyValueHistoryRequest) Send(ctx context.Context) (*GetAssetPropertyValueHistoryResponse, error)

Send marshals and sends the GetAssetPropertyValueHistory API request.

type GetAssetPropertyValueHistoryResponse 

type GetAssetPropertyValueHistoryResponse struct {
	*GetAssetPropertyValueHistoryOutput
	// contains filtered or unexported fields
}

GetAssetPropertyValueHistoryResponse is the response type for the GetAssetPropertyValueHistory API operation.

func (*GetAssetPropertyValueHistoryResponse) SDKResponseMetdata 

func (r *GetAssetPropertyValueHistoryResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetAssetPropertyValueHistory request.

type GetAssetPropertyValueInput 

type GetAssetPropertyValueInput struct {

	// The ID of the asset.
	AssetId *string `location:"querystring" locationName:"assetId" min:"36" type:"string"`

	// The property alias that identifies the property, such as an OPC-UA server
	// data stream path (for example, /company/windfarm/3/turbine/7/temperature).
	// For more information, see Mapping Industrial Data Streams to Asset Properties
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the AWS IoT SiteWise User Guide.
	PropertyAlias *string `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 (GetAssetPropertyValueInput) MarshalFields 

func (s GetAssetPropertyValueInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetAssetPropertyValueInput) String 

func (s GetAssetPropertyValueInput) String() string

String returns the string representation

func (*GetAssetPropertyValueInput) Validate 

func (s *GetAssetPropertyValueInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAssetPropertyValueOutput 

type GetAssetPropertyValueOutput struct {

	// The current asset property value.
	PropertyValue *AssetPropertyValue `locationName:"propertyValue" type:"structure"`
	// contains filtered or unexported fields
}

func (GetAssetPropertyValueOutput) MarshalFields 

func (s GetAssetPropertyValueOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetAssetPropertyValueOutput) String 

func (s GetAssetPropertyValueOutput) String() string

String returns the string representation

type GetAssetPropertyValueRequest 

type GetAssetPropertyValueRequest struct {
	*aws.Request
	Input *GetAssetPropertyValueInput
	Copy  func(*GetAssetPropertyValueInput) GetAssetPropertyValueRequest
}

GetAssetPropertyValueRequest is the request type for the GetAssetPropertyValue API operation.

func (GetAssetPropertyValueRequest) Send 

func (r GetAssetPropertyValueRequest) Send(ctx context.Context) (*GetAssetPropertyValueResponse, error)

Send marshals and sends the GetAssetPropertyValue API request.

type GetAssetPropertyValueResponse 

type GetAssetPropertyValueResponse struct {
	*GetAssetPropertyValueOutput
	// contains filtered or unexported fields
}

GetAssetPropertyValueResponse is the response type for the GetAssetPropertyValue API operation.

func (*GetAssetPropertyValueResponse) SDKResponseMetdata 

func (r *GetAssetPropertyValueResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetAssetPropertyValue request.

type Greengrass 

type Greengrass struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the Greengrass group. For more information about how to find a group's
	// ARN, see ListGroups (https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html)
	// and GetGroup (https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html)
	// in the AWS IoT Greengrass API Reference.
	//
	// GroupArn 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 AWS IoT Greengrass. To create a gateway that runs on AWS IoT Greengrass, you must add the IoT SiteWise connector to a Greengrass group and deploy it. Your Greengrass group must also have permissions to upload data to AWS IoT SiteWise. For more information, see Ingesting data using a gateway (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html) in the AWS IoT SiteWise User Guide.

func (Greengrass) MarshalFields 

func (s Greengrass) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Greengrass) String 

func (s Greengrass) String() string

String returns the string representation

func (*Greengrass) Validate 

func (s *Greengrass) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GroupIdentity 

type GroupIdentity struct {

	// The AWS 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 (GroupIdentity) MarshalFields 

func (s GroupIdentity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GroupIdentity) String 

func (s GroupIdentity) String() string

String returns the string representation

func (*GroupIdentity) Validate 

func (s *GroupIdentity) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Identity 

type Identity struct {

	// A group identity.
	Group *GroupIdentity `locationName:"group" type:"structure"`

	// A user identity.
	User *UserIdentity `locationName:"user" type:"structure"`
	// contains filtered or unexported fields
}

Contains an AWS SSO identity ID for a user or group.

Currently, you can't use AWS APIs to retrieve AWS SSO identity IDs. You can find the AWS SSO identity IDs in the URL of user and group pages in the AWS SSO console (https://console.aws.amazon.com/singlesignon).

func (Identity) MarshalFields 

func (s Identity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Identity) String 

func (s Identity) String() string

String returns the string representation

func (*Identity) Validate 

func (s *Identity) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IdentityType 

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

Enum values for IdentityType

func (IdentityType) MarshalValue 

func (enum IdentityType) MarshalValue() (string, error)

func (IdentityType) MarshalValueBuf 

func (enum IdentityType) MarshalValueBuf(b []byte) ([]byte, error)

type Image 

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 (Image) MarshalFields 

func (s Image) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Image) String 

func (s Image) String() string

String returns the string representation

func (*Image) Validate 

func (s *Image) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ImageFile 

type ImageFile struct {

	// The image file contents, represented as a base64-encoded string. The file
	// size must be less than 1 MB.
	//
	// Data 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 ImageFileType `locationName:"type" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Contains an image file.

func (ImageFile) MarshalFields 

func (s ImageFile) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ImageFile) String 

func (s ImageFile) String() string

String returns the string representation

func (*ImageFile) Validate 

func (s *ImageFile) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ImageFileType 

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

Enum values for ImageFileType

func (ImageFileType) MarshalValue 

func (enum ImageFileType) MarshalValue() (string, error)

func (ImageFileType) MarshalValueBuf 

func (enum ImageFileType) MarshalValueBuf(b []byte) ([]byte, error)

type ImageLocation 

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 AWS IoT SiteWise and available at a URL.

func (ImageLocation) MarshalFields 

func (s ImageLocation) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ImageLocation) String 

func (s ImageLocation) String() string

String returns the string representation

type ListAccessPoliciesInput 

type ListAccessPoliciesInput struct {

	// The ID of the identity. This parameter is required if you specify identityType.
	IdentityId *string `location:"querystring" locationName:"identityId" min:"1" type:"string"`

	// The type of identity (user or group). This parameter is required if you specify
	// identityId.
	IdentityType IdentityType `location:"querystring" locationName:"identityType" type:"string" enum:"true"`

	// The maximum number of results to be returned per paginated request.
	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 ID of the resource. This parameter is required if you specify resourceType.
	ResourceId *string `location:"querystring" locationName:"resourceId" min:"36" type:"string"`

	// The type of resource (portal or project). This parameter is required if you
	// specify resourceId.
	ResourceType ResourceType `location:"querystring" locationName:"resourceType" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (ListAccessPoliciesInput) MarshalFields 

func (s ListAccessPoliciesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListAccessPoliciesInput) String 

func (s ListAccessPoliciesInput) String() string

String returns the string representation

func (*ListAccessPoliciesInput) Validate 

func (s *ListAccessPoliciesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAccessPoliciesOutput 

type ListAccessPoliciesOutput struct {

	// A list that summarizes each access policy.
	//
	// AccessPolicySummaries is a required field
	AccessPolicySummaries []AccessPolicySummary `locationName:"accessPolicySummaries" 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 (ListAccessPoliciesOutput) MarshalFields 

func (s ListAccessPoliciesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListAccessPoliciesOutput) String 

func (s ListAccessPoliciesOutput) String() string

String returns the string representation

type ListAccessPoliciesPaginator 

type ListAccessPoliciesPaginator struct {
	aws.Pager
}

ListAccessPoliciesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListAccessPoliciesPaginator 

func NewListAccessPoliciesPaginator(req ListAccessPoliciesRequest) ListAccessPoliciesPaginator

NewListAccessPoliciesRequestPaginator returns a paginator for ListAccessPolicies. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListAccessPoliciesRequest(input)
p := iotsitewise.NewListAccessPoliciesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListAccessPoliciesPaginator) CurrentPage 

func (p *ListAccessPoliciesPaginator) CurrentPage() *ListAccessPoliciesOutput

type ListAccessPoliciesRequest 

type ListAccessPoliciesRequest struct {
	*aws.Request
	Input *ListAccessPoliciesInput
	Copy  func(*ListAccessPoliciesInput) ListAccessPoliciesRequest
}

ListAccessPoliciesRequest is the request type for the ListAccessPolicies API operation.

func (ListAccessPoliciesRequest) Send 

func (r ListAccessPoliciesRequest) Send(ctx context.Context) (*ListAccessPoliciesResponse, error)

Send marshals and sends the ListAccessPolicies API request.

type ListAccessPoliciesResponse 

type ListAccessPoliciesResponse struct {
	*ListAccessPoliciesOutput
	// contains filtered or unexported fields
}

ListAccessPoliciesResponse is the response type for the ListAccessPolicies API operation.

func (*ListAccessPoliciesResponse) SDKResponseMetdata 

func (r *ListAccessPoliciesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListAccessPolicies request.

type ListAssetModelsInput 

type ListAssetModelsInput struct {

	// The maximum number of results to be returned per paginated request.
	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"`
	// contains filtered or unexported fields
}

func (ListAssetModelsInput) MarshalFields 

func (s ListAssetModelsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListAssetModelsInput) String 

func (s ListAssetModelsInput) String() string

String returns the string representation

func (*ListAssetModelsInput) Validate 

func (s *ListAssetModelsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAssetModelsOutput 

type ListAssetModelsOutput struct {

	// A list that summarizes each asset model.
	//
	// AssetModelSummaries is a required field
	AssetModelSummaries []AssetModelSummary `locationName:"assetModelSummaries" 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 (ListAssetModelsOutput) MarshalFields 

func (s ListAssetModelsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListAssetModelsOutput) String 

func (s ListAssetModelsOutput) String() string

String returns the string representation

type ListAssetModelsPaginator 

type ListAssetModelsPaginator struct {
	aws.Pager
}

ListAssetModelsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListAssetModelsPaginator 

func NewListAssetModelsPaginator(req ListAssetModelsRequest) ListAssetModelsPaginator

NewListAssetModelsRequestPaginator returns a paginator for ListAssetModels. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListAssetModelsRequest(input)
p := iotsitewise.NewListAssetModelsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListAssetModelsPaginator) CurrentPage 

func (p *ListAssetModelsPaginator) CurrentPage() *ListAssetModelsOutput

type ListAssetModelsRequest 

type ListAssetModelsRequest struct {
	*aws.Request
	Input *ListAssetModelsInput
	Copy  func(*ListAssetModelsInput) ListAssetModelsRequest
}

ListAssetModelsRequest is the request type for the ListAssetModels API operation.

func (ListAssetModelsRequest) Send 

func (r ListAssetModelsRequest) Send(ctx context.Context) (*ListAssetModelsResponse, error)

Send marshals and sends the ListAssetModels API request.

type ListAssetModelsResponse 

type ListAssetModelsResponse struct {
	*ListAssetModelsOutput
	// contains filtered or unexported fields
}

ListAssetModelsResponse is the response type for the ListAssetModels API operation.

func (*ListAssetModelsResponse) SDKResponseMetdata 

func (r *ListAssetModelsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListAssetModels request.

type ListAssetsFilter 

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

Enum values for ListAssetsFilter

func (ListAssetsFilter) MarshalValue 

func (enum ListAssetsFilter) MarshalValue() (string, error)

func (ListAssetsFilter) MarshalValueBuf 

func (enum ListAssetsFilter) MarshalValueBuf(b []byte) ([]byte, error)

type ListAssetsInput 

type ListAssetsInput struct {

	// The ID of the asset model by which to filter the list of assets. This parameter
	// is required if you choose ALL for filter.
	AssetModelId *string `location:"querystring" locationName:"assetModelId" min:"36" type:"string"`

	// The filter for the requested list of assets. Choose one of the following
	// options. Defaults to ALL.
	//
	//    * ALL – The list includes all assets for a given asset model ID. The
	//    assetModelId parameter is required if you filter by ALL.
	//
	//    * TOP_LEVEL – The list includes only top-level assets in the asset hierarchy
	//    tree.
	Filter ListAssetsFilter `location:"querystring" locationName:"filter" type:"string" enum:"true"`

	// The maximum number of results to be returned per paginated request.
	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"`
	// contains filtered or unexported fields
}

func (ListAssetsInput) MarshalFields 

func (s ListAssetsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListAssetsInput) String 

func (s ListAssetsInput) String() string

String returns the string representation

func (*ListAssetsInput) Validate 

func (s *ListAssetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAssetsOutput 

type ListAssetsOutput struct {

	// A list that summarizes each asset.
	//
	// AssetSummaries is a required field
	AssetSummaries []AssetSummary `locationName:"assetSummaries" 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 (ListAssetsOutput) MarshalFields 

func (s ListAssetsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListAssetsOutput) String 

func (s ListAssetsOutput) String() string

String returns the string representation

type ListAssetsPaginator 

type ListAssetsPaginator struct {
	aws.Pager
}

ListAssetsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListAssetsPaginator 

func NewListAssetsPaginator(req ListAssetsRequest) ListAssetsPaginator

NewListAssetsRequestPaginator returns a paginator for ListAssets. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListAssetsRequest(input)
p := iotsitewise.NewListAssetsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListAssetsPaginator) CurrentPage 

func (p *ListAssetsPaginator) CurrentPage() *ListAssetsOutput

type ListAssetsRequest 

type ListAssetsRequest struct {
	*aws.Request
	Input *ListAssetsInput
	Copy  func(*ListAssetsInput) ListAssetsRequest
}

ListAssetsRequest is the request type for the ListAssets API operation.

func (ListAssetsRequest) Send 

func (r ListAssetsRequest) Send(ctx context.Context) (*ListAssetsResponse, error)

Send marshals and sends the ListAssets API request.

type ListAssetsResponse 

type ListAssetsResponse struct {
	*ListAssetsOutput
	// contains filtered or unexported fields
}

ListAssetsResponse is the response type for the ListAssets API operation.

func (*ListAssetsResponse) SDKResponseMetdata 

func (r *ListAssetsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListAssets request.

type ListAssociatedAssetsInput 

type ListAssociatedAssetsInput 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 hierarchy ID (of the parent asset model) whose associated assets are
	// returned. To find a hierarchy ID, use the DescribeAsset (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html)
	// or DescribeAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html)
	// actions.
	//
	// For more information, see Asset Hierarchies (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html)
	// in the AWS IoT SiteWise User Guide.
	//
	// HierarchyId is a required field
	HierarchyId *string `location:"querystring" locationName:"hierarchyId" min:"36" type:"string" required:"true"`

	// The maximum number of results to be returned per paginated request.
	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"`
	// contains filtered or unexported fields
}

func (ListAssociatedAssetsInput) MarshalFields 

func (s ListAssociatedAssetsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListAssociatedAssetsInput) String 

func (s ListAssociatedAssetsInput) String() string

String returns the string representation

func (*ListAssociatedAssetsInput) Validate 

func (s *ListAssociatedAssetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAssociatedAssetsOutput 

type ListAssociatedAssetsOutput struct {

	// A list that summarizes the associated assets.
	//
	// AssetSummaries is a required field
	AssetSummaries []AssociatedAssetsSummary `locationName:"assetSummaries" 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 (ListAssociatedAssetsOutput) MarshalFields 

func (s ListAssociatedAssetsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListAssociatedAssetsOutput) String 

func (s ListAssociatedAssetsOutput) String() string

String returns the string representation

type ListAssociatedAssetsPaginator 

type ListAssociatedAssetsPaginator struct {
	aws.Pager
}

ListAssociatedAssetsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListAssociatedAssetsPaginator 

func NewListAssociatedAssetsPaginator(req ListAssociatedAssetsRequest) ListAssociatedAssetsPaginator

NewListAssociatedAssetsRequestPaginator returns a paginator for ListAssociatedAssets. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListAssociatedAssetsRequest(input)
p := iotsitewise.NewListAssociatedAssetsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListAssociatedAssetsPaginator) CurrentPage 

func (p *ListAssociatedAssetsPaginator) CurrentPage() *ListAssociatedAssetsOutput

type ListAssociatedAssetsRequest 

type ListAssociatedAssetsRequest struct {
	*aws.Request
	Input *ListAssociatedAssetsInput
	Copy  func(*ListAssociatedAssetsInput) ListAssociatedAssetsRequest
}

ListAssociatedAssetsRequest is the request type for the ListAssociatedAssets API operation.

func (ListAssociatedAssetsRequest) Send 

func (r ListAssociatedAssetsRequest) Send(ctx context.Context) (*ListAssociatedAssetsResponse, error)

Send marshals and sends the ListAssociatedAssets API request.

type ListAssociatedAssetsResponse 

type ListAssociatedAssetsResponse struct {
	*ListAssociatedAssetsOutput
	// contains filtered or unexported fields
}

ListAssociatedAssetsResponse is the response type for the ListAssociatedAssets API operation.

func (*ListAssociatedAssetsResponse) SDKResponseMetdata 

func (r *ListAssociatedAssetsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListAssociatedAssets request.

type ListDashboardsInput 

type ListDashboardsInput struct {

	// The maximum number of results to be returned per paginated request.
	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 ID of the project.
	//
	// ProjectId is a required field
	ProjectId *string `location:"querystring" locationName:"projectId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListDashboardsInput) MarshalFields 

func (s ListDashboardsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListDashboardsInput) String 

func (s ListDashboardsInput) String() string

String returns the string representation

func (*ListDashboardsInput) Validate 

func (s *ListDashboardsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDashboardsOutput 

type ListDashboardsOutput struct {

	// A list that summarizes each dashboard in the project.
	//
	// DashboardSummaries is a required field
	DashboardSummaries []DashboardSummary `locationName:"dashboardSummaries" 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 (ListDashboardsOutput) MarshalFields 

func (s ListDashboardsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListDashboardsOutput) String 

func (s ListDashboardsOutput) String() string

String returns the string representation

type ListDashboardsPaginator 

type ListDashboardsPaginator struct {
	aws.Pager
}

ListDashboardsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListDashboardsPaginator 

func NewListDashboardsPaginator(req ListDashboardsRequest) ListDashboardsPaginator

NewListDashboardsRequestPaginator returns a paginator for ListDashboards. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListDashboardsRequest(input)
p := iotsitewise.NewListDashboardsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListDashboardsPaginator) CurrentPage 

func (p *ListDashboardsPaginator) CurrentPage() *ListDashboardsOutput

type ListDashboardsRequest 

type ListDashboardsRequest struct {
	*aws.Request
	Input *ListDashboardsInput
	Copy  func(*ListDashboardsInput) ListDashboardsRequest
}

ListDashboardsRequest is the request type for the ListDashboards API operation.

func (ListDashboardsRequest) Send 

func (r ListDashboardsRequest) Send(ctx context.Context) (*ListDashboardsResponse, error)

Send marshals and sends the ListDashboards API request.

type ListDashboardsResponse 

type ListDashboardsResponse struct {
	*ListDashboardsOutput
	// contains filtered or unexported fields
}

ListDashboardsResponse is the response type for the ListDashboards API operation.

func (*ListDashboardsResponse) SDKResponseMetdata 

func (r *ListDashboardsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListDashboards request.

type ListGatewaysInput 

type ListGatewaysInput struct {

	// The maximum number of results to be returned per paginated request.
	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"`
	// contains filtered or unexported fields
}

func (ListGatewaysInput) MarshalFields 

func (s ListGatewaysInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListGatewaysInput) String 

func (s ListGatewaysInput) String() string

String returns the string representation

func (*ListGatewaysInput) Validate 

func (s *ListGatewaysInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListGatewaysOutput 

type ListGatewaysOutput struct {

	// A list that summarizes each gateway.
	//
	// GatewaySummaries is a required field
	GatewaySummaries []GatewaySummary `locationName:"gatewaySummaries" 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 (ListGatewaysOutput) MarshalFields 

func (s ListGatewaysOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListGatewaysOutput) String 

func (s ListGatewaysOutput) String() string

String returns the string representation

type ListGatewaysPaginator 

type ListGatewaysPaginator struct {
	aws.Pager
}

ListGatewaysPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListGatewaysPaginator 

func NewListGatewaysPaginator(req ListGatewaysRequest) ListGatewaysPaginator

NewListGatewaysRequestPaginator returns a paginator for ListGateways. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListGatewaysRequest(input)
p := iotsitewise.NewListGatewaysRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListGatewaysPaginator) CurrentPage 

func (p *ListGatewaysPaginator) CurrentPage() *ListGatewaysOutput

type ListGatewaysRequest 

type ListGatewaysRequest struct {
	*aws.Request
	Input *ListGatewaysInput
	Copy  func(*ListGatewaysInput) ListGatewaysRequest
}

ListGatewaysRequest is the request type for the ListGateways API operation.

func (ListGatewaysRequest) Send 

func (r ListGatewaysRequest) Send(ctx context.Context) (*ListGatewaysResponse, error)

Send marshals and sends the ListGateways API request.

type ListGatewaysResponse 

type ListGatewaysResponse struct {
	*ListGatewaysOutput
	// contains filtered or unexported fields
}

ListGatewaysResponse is the response type for the ListGateways API operation.

func (*ListGatewaysResponse) SDKResponseMetdata 

func (r *ListGatewaysResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListGateways request.

type ListPortalsInput 

type ListPortalsInput struct {

	// The maximum number of results to be returned per paginated request.
	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"`
	// contains filtered or unexported fields
}

func (ListPortalsInput) MarshalFields 

func (s ListPortalsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListPortalsInput) String 

func (s ListPortalsInput) String() string

String returns the string representation

func (*ListPortalsInput) Validate 

func (s *ListPortalsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPortalsOutput 

type ListPortalsOutput struct {

	// 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 that summarizes each portal.
	PortalSummaries []PortalSummary `locationName:"portalSummaries" type:"list"`
	// contains filtered or unexported fields
}

func (ListPortalsOutput) MarshalFields 

func (s ListPortalsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListPortalsOutput) String 

func (s ListPortalsOutput) String() string

String returns the string representation

type ListPortalsPaginator 

type ListPortalsPaginator struct {
	aws.Pager
}

ListPortalsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListPortalsPaginator 

func NewListPortalsPaginator(req ListPortalsRequest) ListPortalsPaginator

NewListPortalsRequestPaginator returns a paginator for ListPortals. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListPortalsRequest(input)
p := iotsitewise.NewListPortalsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListPortalsPaginator) CurrentPage 

func (p *ListPortalsPaginator) CurrentPage() *ListPortalsOutput

type ListPortalsRequest 

type ListPortalsRequest struct {
	*aws.Request
	Input *ListPortalsInput
	Copy  func(*ListPortalsInput) ListPortalsRequest
}

ListPortalsRequest is the request type for the ListPortals API operation.

func (ListPortalsRequest) Send 

func (r ListPortalsRequest) Send(ctx context.Context) (*ListPortalsResponse, error)

Send marshals and sends the ListPortals API request.

type ListPortalsResponse 

type ListPortalsResponse struct {
	*ListPortalsOutput
	// contains filtered or unexported fields
}

ListPortalsResponse is the response type for the ListPortals API operation.

func (*ListPortalsResponse) SDKResponseMetdata 

func (r *ListPortalsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListPortals request.

type ListProjectAssetsInput 

type ListProjectAssetsInput struct {

	// The maximum number of results to be returned per paginated request.
	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 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 (ListProjectAssetsInput) MarshalFields 

func (s ListProjectAssetsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListProjectAssetsInput) String 

func (s ListProjectAssetsInput) String() string

String returns the string representation

func (*ListProjectAssetsInput) Validate 

func (s *ListProjectAssetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListProjectAssetsOutput 

type ListProjectAssetsOutput struct {

	// A list that contains the IDs of each asset associated with the project.
	//
	// AssetIds is a required field
	AssetIds []string `locationName:"assetIds" 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 (ListProjectAssetsOutput) MarshalFields 

func (s ListProjectAssetsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListProjectAssetsOutput) String 

func (s ListProjectAssetsOutput) String() string

String returns the string representation

type ListProjectAssetsPaginator 

type ListProjectAssetsPaginator struct {
	aws.Pager
}

ListProjectAssetsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListProjectAssetsPaginator 

func NewListProjectAssetsPaginator(req ListProjectAssetsRequest) ListProjectAssetsPaginator

NewListProjectAssetsRequestPaginator returns a paginator for ListProjectAssets. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListProjectAssetsRequest(input)
p := iotsitewise.NewListProjectAssetsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListProjectAssetsPaginator) CurrentPage 

func (p *ListProjectAssetsPaginator) CurrentPage() *ListProjectAssetsOutput

type ListProjectAssetsRequest 

type ListProjectAssetsRequest struct {
	*aws.Request
	Input *ListProjectAssetsInput
	Copy  func(*ListProjectAssetsInput) ListProjectAssetsRequest
}

ListProjectAssetsRequest is the request type for the ListProjectAssets API operation.

func (ListProjectAssetsRequest) Send 

func (r ListProjectAssetsRequest) Send(ctx context.Context) (*ListProjectAssetsResponse, error)

Send marshals and sends the ListProjectAssets API request.

type ListProjectAssetsResponse 

type ListProjectAssetsResponse struct {
	*ListProjectAssetsOutput
	// contains filtered or unexported fields
}

ListProjectAssetsResponse is the response type for the ListProjectAssets API operation.

func (*ListProjectAssetsResponse) SDKResponseMetdata 

func (r *ListProjectAssetsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListProjectAssets request.

type ListProjectsInput 

type ListProjectsInput struct {

	// The maximum number of results to be returned per paginated request.
	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 ID of the portal.
	//
	// PortalId is a required field
	PortalId *string `location:"querystring" locationName:"portalId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListProjectsInput) MarshalFields 

func (s ListProjectsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListProjectsInput) String 

func (s ListProjectsInput) String() string

String returns the string representation

func (*ListProjectsInput) Validate 

func (s *ListProjectsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListProjectsOutput 

type ListProjectsOutput struct {

	// 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 that summarizes each project in the portal.
	//
	// ProjectSummaries is a required field
	ProjectSummaries []ProjectSummary `locationName:"projectSummaries" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListProjectsOutput) MarshalFields 

func (s ListProjectsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListProjectsOutput) String 

func (s ListProjectsOutput) String() string

String returns the string representation

type ListProjectsPaginator 

type ListProjectsPaginator struct {
	aws.Pager
}

ListProjectsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListProjectsPaginator 

func NewListProjectsPaginator(req ListProjectsRequest) ListProjectsPaginator

NewListProjectsRequestPaginator returns a paginator for ListProjects. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListProjectsRequest(input)
p := iotsitewise.NewListProjectsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListProjectsPaginator) CurrentPage 

func (p *ListProjectsPaginator) CurrentPage() *ListProjectsOutput

type ListProjectsRequest 

type ListProjectsRequest struct {
	*aws.Request
	Input *ListProjectsInput
	Copy  func(*ListProjectsInput) ListProjectsRequest
}

ListProjectsRequest is the request type for the ListProjects API operation.

func (ListProjectsRequest) Send 

func (r ListProjectsRequest) Send(ctx context.Context) (*ListProjectsResponse, error)

Send marshals and sends the ListProjects API request.

type ListProjectsResponse 

type ListProjectsResponse struct {
	*ListProjectsOutput
	// contains filtered or unexported fields
}

ListProjectsResponse is the response type for the ListProjects API operation.

func (*ListProjectsResponse) SDKResponseMetdata 

func (r *ListProjectsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListProjects request.

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"querystring" locationName:"resourceArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) MarshalFields 

func (s ListTagsForResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The list of key-value pairs that contain metadata for the resource. For more
	// information, see Tagging your AWS IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
	// in the AWS IoT SiteWise User Guide.
	Tags map[string]string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) MarshalFields 

func (s ListTagsForResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type LoggingLevel 

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

Enum values for LoggingLevel

func (LoggingLevel) MarshalValue 

func (enum LoggingLevel) MarshalValue() (string, error)

func (LoggingLevel) MarshalValueBuf 

func (enum LoggingLevel) MarshalValueBuf(b []byte) ([]byte, error)

type LoggingOptions 

type LoggingOptions struct {

	// The AWS IoT SiteWise logging verbosity level.
	//
	// Level is a required field
	Level LoggingLevel `locationName:"level" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Contains logging options.

func (LoggingOptions) MarshalFields 

func (s LoggingOptions) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (LoggingOptions) String 

func (s LoggingOptions) String() string

String returns the string representation

func (*LoggingOptions) Validate 

func (s *LoggingOptions) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Measurement 

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

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

func (Measurement) MarshalFields 

func (s Measurement) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Measurement) String 

func (s Measurement) String() string

String returns the string representation

type Metric 

type Metric struct {

	// The mathematical expression that defines the metric aggregation function.
	// You can specify up to 10 variables per expression. You can specify up to
	// 10 functions per expression.
	//
	// For more information, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html)
	// in the AWS IoT SiteWise User Guide.
	//
	// Expression is a required field
	Expression *string `locationName:"expression" min:"1" type:"string" required:"true"`

	// The list of variables used in the expression.
	//
	// Variables is a required field
	Variables []ExpressionVariable `locationName:"variables" type:"list" required:"true"`

	// The window (time interval) over which AWS IoT SiteWise computes the metric's
	// aggregation expression. AWS IoT SiteWise computes one data point per window.
	//
	// Window is a required field
	Window *MetricWindow `locationName:"window" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains an asset metric property. With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum).

The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a root metric can have up to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE.

For more information, see Metrics (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics) in the AWS IoT SiteWise User Guide.

func (Metric) MarshalFields 

func (s Metric) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Metric) String 

func (s Metric) String() string

String returns the string representation

func (*Metric) Validate 

func (s *Metric) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MetricWindow 

type MetricWindow struct {

	// The tumbling time interval window.
	Tumbling *TumblingWindow `locationName:"tumbling" type:"structure"`
	// contains filtered or unexported fields
}

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

func (MetricWindow) MarshalFields 

func (s MetricWindow) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MetricWindow) String 

func (s MetricWindow) String() string

String returns the string representation

func (*MetricWindow) Validate 

func (s *MetricWindow) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MonitorErrorCode 

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

Enum values for MonitorErrorCode

func (MonitorErrorCode) MarshalValue 

func (enum MonitorErrorCode) MarshalValue() (string, error)

func (MonitorErrorCode) MarshalValueBuf 

func (enum MonitorErrorCode) MarshalValueBuf(b []byte) ([]byte, error)

type MonitorErrorDetails 

type MonitorErrorDetails struct {

	// The error code.
	Code MonitorErrorCode `locationName:"code" type:"string" enum:"true"`

	// The error message.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Contains AWS IoT SiteWise Monitor error details.

func (MonitorErrorDetails) MarshalFields 

func (s MonitorErrorDetails) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (MonitorErrorDetails) String 

func (s MonitorErrorDetails) String() string

String returns the string representation

type Permission 

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

Enum values for Permission

func (Permission) MarshalValue 

func (enum Permission) MarshalValue() (string, error)

func (Permission) MarshalValueBuf 

func (enum Permission) MarshalValueBuf(b []byte) ([]byte, error)

type PortalResource 

type PortalResource struct {

	// The ID of the portal.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Identifies an AWS IoT SiteWise Monitor portal.

func (PortalResource) MarshalFields 

func (s PortalResource) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PortalResource) String 

func (s PortalResource) String() string

String returns the string representation

func (*PortalResource) Validate 

func (s *PortalResource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PortalState 

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

Enum values for PortalState

func (PortalState) MarshalValue 

func (enum PortalState) MarshalValue() (string, error)

func (PortalState) MarshalValueBuf 

func (enum PortalState) MarshalValueBuf(b []byte) ([]byte, error)

type PortalStatus 

type PortalStatus struct {

	// Contains associated error information, if any.
	Error *MonitorErrorDetails `locationName:"error" type:"structure"`

	// The current state of the portal.
	//
	// State is a required field
	State PortalState `locationName:"state" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

Contains information about the current status of a portal.

func (PortalStatus) MarshalFields 

func (s PortalStatus) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PortalStatus) String 

func (s PortalStatus) String() string

String returns the string representation

type PortalSummary 

type PortalSummary struct {

	// The date the portal was created, in Unix epoch time.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// The portal's description.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The ID of the portal.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`

	// The date the portal was last updated, in Unix epoch time.
	LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp"`

	// The name of the portal.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" 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 AWS IoT
	// SiteWise resources on your behalf. For more information, see Using service
	// roles for AWS IoT SiteWise Monitor (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html)
	// in the AWS IoT SiteWise User Guide.
	RoleArn *string `locationName:"roleArn" min:"1" type:"string"`

	// The public root URL for the AWS IoT AWS IoT SiteWise Monitor application
	// portal.
	//
	// StartUrl is a required field
	StartUrl *string `locationName:"startUrl" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains a portal summary.

func (PortalSummary) MarshalFields 

func (s PortalSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PortalSummary) String 

func (s PortalSummary) String() string

String returns the string representation

type ProjectResource 

type ProjectResource struct {

	// The ID of the project.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Identifies a specific AWS IoT SiteWise Monitor project.

func (ProjectResource) MarshalFields 

func (s ProjectResource) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ProjectResource) String 

func (s ProjectResource) String() string

String returns the string representation

func (*ProjectResource) Validate 

func (s *ProjectResource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ProjectSummary 

type ProjectSummary struct {

	// The date the project was created, in Unix epoch time.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// The project's description.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The ID of the project.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`

	// The date the project was last updated, in Unix epoch time.
	LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp"`

	// The name of the project.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains project summary information.

func (ProjectSummary) MarshalFields 

func (s ProjectSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ProjectSummary) String 

func (s ProjectSummary) String() string

String returns the string representation

type Property 

type Property struct {

	// The property alias that identifies the property, such as an OPC-UA server
	// data stream path (for example, /company/windfarm/3/turbine/7/temperature).
	// For more information, see Mapping Industrial Data Streams to Asset Properties
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the AWS IoT SiteWise User Guide.
	Alias *string `locationName:"alias" min:"1" type:"string"`

	// The property data type.
	//
	// DataType is a required field
	DataType PropertyDataType `locationName:"dataType" type:"string" required:"true" enum:"true"`

	// 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 property type (see PropertyType). A property contains one type.
	Type *PropertyType `locationName:"type" 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 (Property) MarshalFields 

func (s Property) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Property) String 

func (s Property) String() string

String returns the string representation

type PropertyDataType 

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

Enum values for PropertyDataType

func (PropertyDataType) MarshalValue 

func (enum PropertyDataType) MarshalValue() (string, error)

func (PropertyDataType) MarshalValueBuf 

func (enum PropertyDataType) MarshalValueBuf(b []byte) ([]byte, error)

type PropertyNotification 

type PropertyNotification struct {

	// The current notification state.
	//
	// State is a required field
	State PropertyNotificationState `locationName:"state" type:"string" required:"true" enum:"true"`

	// The MQTT topic to which AWS IoT SiteWise publishes property value update
	// notifications.
	//
	// Topic is a required field
	Topic *string `locationName:"topic" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (PropertyNotification) MarshalFields 

func (s PropertyNotification) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PropertyNotification) String 

func (s PropertyNotification) String() string

String returns the string representation

type PropertyNotificationState 

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

Enum values for PropertyNotificationState

func (PropertyNotificationState) MarshalValue 

func (enum PropertyNotificationState) MarshalValue() (string, error)

func (PropertyNotificationState) MarshalValueBuf 

func (enum PropertyNotificationState) MarshalValueBuf(b []byte) ([]byte, error)

type PropertyType 

type PropertyType struct {

	// Specifies an asset attribute property. An attribute generally contains static
	// information, such as the serial number of an IIoT (https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications)
	// wind turbine.
	Attribute *Attribute `locationName:"attribute" type:"structure"`

	// Specifies an asset measurement property. A measurement represents a device's
	// raw sensor data stream, such as timestamped temperature values or timestamped
	// power values.
	Measurement *Measurement `locationName:"measurement" type:"structure"`

	// Specifies an asset metric property. A metric contains a mathematical expression
	// that uses aggregate functions to process all input data points over a time
	// interval and output a single data point, such as to calculate the average
	// hourly temperature.
	Metric *Metric `locationName:"metric" type:"structure"`

	// Specifies an asset transform property. A transform contains a mathematical
	// expression that maps a property's data points from one form to another, such
	// as a unit conversion from Celsius to Fahrenheit.
	Transform *Transform `locationName:"transform" type:"structure"`
	// contains filtered or unexported fields
}

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

func (PropertyType) MarshalFields 

func (s PropertyType) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PropertyType) String 

func (s PropertyType) String() string

String returns the string representation

func (*PropertyType) Validate 

func (s *PropertyType) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutAssetPropertyValueEntry 

type PutAssetPropertyValueEntry struct {

	// The ID of the asset to update.
	AssetId *string `locationName:"assetId" min:"36" type:"string"`

	// The user specified ID for the entry. You can use this ID to identify which
	// entries failed.
	//
	// EntryId is a required field
	EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"`

	// The property alias that identifies the property, such as an OPC-UA server
	// data stream path (for example, /company/windfarm/3/turbine/7/temperature).
	// For more information, see Mapping Industrial Data Streams to Asset Properties
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the AWS IoT SiteWise User Guide.
	PropertyAlias *string `locationName:"propertyAlias" min:"1" type:"string"`

	// The ID of the asset property for this entry.
	PropertyId *string `locationName:"propertyId" min:"36" type:"string"`

	// The list of property values to upload. You can specify up to 10 propertyValues
	// array elements.
	//
	// PropertyValues is a required field
	PropertyValues []AssetPropertyValue `locationName:"propertyValues" type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

func (PutAssetPropertyValueEntry) MarshalFields 

func (s PutAssetPropertyValueEntry) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutAssetPropertyValueEntry) String 

func (s PutAssetPropertyValueEntry) String() string

String returns the string representation

func (*PutAssetPropertyValueEntry) Validate 

func (s *PutAssetPropertyValueEntry) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutLoggingOptionsInput 

type PutLoggingOptionsInput struct {

	// The logging options to set.
	//
	// LoggingOptions is a required field
	LoggingOptions *LoggingOptions `locationName:"loggingOptions" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutLoggingOptionsInput) MarshalFields 

func (s PutLoggingOptionsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutLoggingOptionsInput) String 

func (s PutLoggingOptionsInput) String() string

String returns the string representation

func (*PutLoggingOptionsInput) Validate 

func (s *PutLoggingOptionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutLoggingOptionsOutput 

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

func (PutLoggingOptionsOutput) MarshalFields 

func (s PutLoggingOptionsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PutLoggingOptionsOutput) String 

func (s PutLoggingOptionsOutput) String() string

String returns the string representation

type PutLoggingOptionsRequest 

type PutLoggingOptionsRequest struct {
	*aws.Request
	Input *PutLoggingOptionsInput
	Copy  func(*PutLoggingOptionsInput) PutLoggingOptionsRequest
}

PutLoggingOptionsRequest is the request type for the PutLoggingOptions API operation.

func (PutLoggingOptionsRequest) Send 

func (r PutLoggingOptionsRequest) Send(ctx context.Context) (*PutLoggingOptionsResponse, error)

Send marshals and sends the PutLoggingOptions API request.

type PutLoggingOptionsResponse 

type PutLoggingOptionsResponse struct {
	*PutLoggingOptionsOutput
	// contains filtered or unexported fields
}

PutLoggingOptionsResponse is the response type for the PutLoggingOptions API operation.

func (*PutLoggingOptionsResponse) SDKResponseMetdata 

func (r *PutLoggingOptionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutLoggingOptions request.

type Quality 

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

Enum values for Quality

func (Quality) MarshalValue 

func (enum Quality) MarshalValue() (string, error)

func (Quality) MarshalValueBuf 

func (enum Quality) MarshalValueBuf(b []byte) ([]byte, error)

type Resource 

type Resource struct {

	// A portal resource.
	Portal *PortalResource `locationName:"portal" type:"structure"`

	// A project resource.
	Project *ProjectResource `locationName:"project" type:"structure"`
	// contains filtered or unexported fields
}

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

func (Resource) MarshalFields 

func (s Resource) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Resource) String 

func (s Resource) String() string

String returns the string representation

func (*Resource) Validate 

func (s *Resource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceType 

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

Enum values for ResourceType

func (ResourceType) MarshalValue 

func (enum ResourceType) MarshalValue() (string, error)

func (ResourceType) MarshalValueBuf 

func (enum ResourceType) MarshalValueBuf(b []byte) ([]byte, error)

type TagResourceInput 

type TagResourceInput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the resource to tag.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"querystring" locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// A list of key-value pairs that contain metadata for the resource. For more
	// information, see Tagging your AWS IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
	// in the AWS IoT SiteWise User Guide.
	//
	// Tags is a required field
	Tags map[string]string `locationName:"tags" min:"1" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) MarshalFields 

func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput 

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

func (TagResourceOutput) MarshalFields 

func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse 

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type TimeInNanos 

type TimeInNanos struct {

	// The nanosecond offset from timeInSeconds.
	OffsetInNanos *int64 `locationName:"offsetInNanos" type:"integer"`

	// The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond
	// data is provided by offsetInNanos.
	//
	// TimeInSeconds is a required field
	TimeInSeconds *int64 `locationName:"timeInSeconds" min:"1" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Contains a timestamp with optional nanosecond granularity.

func (TimeInNanos) MarshalFields 

func (s TimeInNanos) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TimeInNanos) String 

func (s TimeInNanos) String() string

String returns the string representation

func (*TimeInNanos) Validate 

func (s *TimeInNanos) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TimeOrdering 

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

Enum values for TimeOrdering

func (TimeOrdering) MarshalValue 

func (enum TimeOrdering) MarshalValue() (string, error)

func (TimeOrdering) MarshalValueBuf 

func (enum TimeOrdering) MarshalValueBuf(b []byte) ([]byte, error)

type Transform 

type Transform struct {

	// The mathematical expression that defines the transformation function. You
	// can specify up to 10 variables per expression. You can specify up to 10 functions
	// per expression.
	//
	// For more information, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html)
	// in the AWS IoT SiteWise User Guide.
	//
	// Expression is a required field
	Expression *string `locationName:"expression" min:"1" type:"string" required:"true"`

	// The list of variables used in the expression.
	//
	// Variables is a required field
	Variables []ExpressionVariable `locationName:"variables" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains an asset transform property. A transform is a one-to-one mapping of a property's data points from one form to another. For example, you can use a transform to convert a Celsius data stream to Fahrenheit by applying the transformation expression to each data point of the Celsius stream. A transform can only have a data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE.

For more information, see Transforms (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#transforms) in the AWS IoT SiteWise User Guide.

func (Transform) MarshalFields 

func (s Transform) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Transform) String 

func (s Transform) String() string

String returns the string representation

func (*Transform) Validate 

func (s *Transform) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TumblingWindow 

type TumblingWindow struct {

	// The time interval for the tumbling window. Note that w represents weeks,
	// d represents days, h represents hours, and m represents minutes. AWS IoT
	// SiteWise computes the 1w interval the end of Sunday at midnight each week
	// (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval
	// at the end of each hour, and so on.
	//
	// When AWS IoT SiteWise aggregates data points for metric computations, the
	// start of each interval is exclusive and the end of each interval is inclusive.
	// AWS IoT SiteWise places the computed data point at the end of the interval.
	//
	// Interval is a required field
	Interval *string `locationName:"interval" min:"2" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (TumblingWindow) MarshalFields 

func (s TumblingWindow) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TumblingWindow) String 

func (s TumblingWindow) String() string

String returns the string representation

func (*TumblingWindow) Validate 

func (s *TumblingWindow) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the resource to untag.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"querystring" locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// A list of keys for tags to remove from the resource.
	//
	// TagKeys is a required field
	TagKeys []string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) MarshalFields 

func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput 

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

func (UntagResourceOutput) MarshalFields 

func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse 

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateAccessPolicyInput 

type UpdateAccessPolicyInput struct {

	// The ID of the access policy.
	//
	// AccessPolicyId is a required field
	AccessPolicyId *string `location:"uri" locationName:"accessPolicyId" min:"36" type:"string" required:"true"`

	// The identity for this access policy. Choose either a user or a group but
	// not both.
	//
	// 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 Permission `locationName:"accessPolicyPermission" type:"string" required:"true" enum:"true"`

	// The AWS IoT SiteWise Monitor resource for this access policy. Choose either
	// portal or project but not both.
	//
	// 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"`
	// contains filtered or unexported fields
}

func (UpdateAccessPolicyInput) MarshalFields 

func (s UpdateAccessPolicyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateAccessPolicyInput) String 

func (s UpdateAccessPolicyInput) String() string

String returns the string representation

func (*UpdateAccessPolicyInput) Validate 

func (s *UpdateAccessPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAccessPolicyOutput 

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

func (UpdateAccessPolicyOutput) MarshalFields 

func (s UpdateAccessPolicyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateAccessPolicyOutput) String 

func (s UpdateAccessPolicyOutput) String() string

String returns the string representation

type UpdateAccessPolicyRequest 

type UpdateAccessPolicyRequest struct {
	*aws.Request
	Input *UpdateAccessPolicyInput
	Copy  func(*UpdateAccessPolicyInput) UpdateAccessPolicyRequest
}

UpdateAccessPolicyRequest is the request type for the UpdateAccessPolicy API operation.

func (UpdateAccessPolicyRequest) Send 

func (r UpdateAccessPolicyRequest) Send(ctx context.Context) (*UpdateAccessPolicyResponse, error)

Send marshals and sends the UpdateAccessPolicy API request.

type UpdateAccessPolicyResponse 

type UpdateAccessPolicyResponse struct {
	*UpdateAccessPolicyOutput
	// contains filtered or unexported fields
}

UpdateAccessPolicyResponse is the response type for the UpdateAccessPolicy API operation.

func (*UpdateAccessPolicyResponse) SDKResponseMetdata 

func (r *UpdateAccessPolicyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateAccessPolicy request.

type UpdateAssetInput 

type UpdateAssetInput struct {

	// The ID of the asset to update.
	//
	// AssetId is a required field
	AssetId *string `location:"uri" locationName:"assetId" 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"`
	// contains filtered or unexported fields
}

func (UpdateAssetInput) MarshalFields 

func (s UpdateAssetInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateAssetInput) String 

func (s UpdateAssetInput) String() string

String returns the string representation

func (*UpdateAssetInput) Validate 

func (s *UpdateAssetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAssetModelInput 

type UpdateAssetModelInput struct {

	// A description for the asset model.
	AssetModelDescription *string `locationName:"assetModelDescription" min:"1" type:"string"`

	// The updated hierarchy definitions of the asset model. Each hierarchy specifies
	// an asset model whose assets can be children of any other assets created from
	// this asset model. For more information, see Asset Hierarchies (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html)
	// in the AWS 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 AWS IoT SiteWise User Guide.
	AssetModelHierarchies []AssetModelHierarchy `locationName:"assetModelHierarchies" type:"list"`

	// The ID of the asset model to update.
	//
	// AssetModelId is a required field
	AssetModelId *string `location:"uri" locationName:"assetModelId" min:"36" type:"string" required:"true"`

	// A unique, friendly name for the asset model.
	//
	// AssetModelName is a required field
	AssetModelName *string `locationName:"assetModelName" min:"1" type:"string" required:"true"`

	// The updated 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 AWS 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 AWS IoT SiteWise User Guide.
	AssetModelProperties []AssetModelProperty `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"`
	// contains filtered or unexported fields
}

func (UpdateAssetModelInput) MarshalFields 

func (s UpdateAssetModelInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateAssetModelInput) String 

func (s UpdateAssetModelInput) String() string

String returns the string representation

func (*UpdateAssetModelInput) Validate 

func (s *UpdateAssetModelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAssetModelOutput 

type UpdateAssetModelOutput struct {

	// The status of the asset model, which contains a state (UPDATING 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 (UpdateAssetModelOutput) MarshalFields 

func (s UpdateAssetModelOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateAssetModelOutput) String 

func (s UpdateAssetModelOutput) String() string

String returns the string representation

type UpdateAssetModelRequest 

type UpdateAssetModelRequest struct {
	*aws.Request
	Input *UpdateAssetModelInput
	Copy  func(*UpdateAssetModelInput) UpdateAssetModelRequest
}

UpdateAssetModelRequest is the request type for the UpdateAssetModel API operation.

func (UpdateAssetModelRequest) Send 

func (r UpdateAssetModelRequest) Send(ctx context.Context) (*UpdateAssetModelResponse, error)

Send marshals and sends the UpdateAssetModel API request.

type UpdateAssetModelResponse 

type UpdateAssetModelResponse struct {
	*UpdateAssetModelOutput
	// contains filtered or unexported fields
}

UpdateAssetModelResponse is the response type for the UpdateAssetModel API operation.

func (*UpdateAssetModelResponse) SDKResponseMetdata 

func (r *UpdateAssetModelResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateAssetModel request.

type UpdateAssetOutput 

type UpdateAssetOutput struct {

	// The status of the asset, which contains a state (UPDATING 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 (UpdateAssetOutput) MarshalFields 

func (s UpdateAssetOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateAssetOutput) String 

func (s UpdateAssetOutput) String() string

String returns the string representation

type UpdateAssetPropertyInput 

type UpdateAssetPropertyInput struct {

	// The ID of the asset to be updated.
	//
	// 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 `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// The property alias that identifies the property, such as an OPC-UA server
	// data stream path (for example, /company/windfarm/3/turbine/7/temperature).
	// For more information, see Mapping Industrial Data Streams to Asset Properties
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the AWS IoT SiteWise User Guide.
	//
	// If you omit this parameter, the alias is removed from the property.
	PropertyAlias *string `locationName:"propertyAlias" min:"1" type:"string"`

	// The ID of the asset property to be updated.
	//
	// PropertyId is a required field
	PropertyId *string `location:"uri" locationName:"propertyId" min:"36" type:"string" required:"true"`

	// The MQTT notification state (enabled or disabled) for this asset property.
	// When the notification state is enabled, AWS IoT SiteWise publishes property
	// value updates to a unique MQTT topic. For more information, see Interacting
	// with Other Services (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html)
	// in the AWS IoT SiteWise User Guide.
	//
	// If you omit this parameter, the notification state is set to DISABLED.
	PropertyNotificationState PropertyNotificationState `locationName:"propertyNotificationState" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (UpdateAssetPropertyInput) MarshalFields 

func (s UpdateAssetPropertyInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateAssetPropertyInput) String 

func (s UpdateAssetPropertyInput) String() string

String returns the string representation

func (*UpdateAssetPropertyInput) Validate 

func (s *UpdateAssetPropertyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAssetPropertyOutput 

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

func (UpdateAssetPropertyOutput) MarshalFields 

func (s UpdateAssetPropertyOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateAssetPropertyOutput) String 

func (s UpdateAssetPropertyOutput) String() string

String returns the string representation

type UpdateAssetPropertyRequest 

type UpdateAssetPropertyRequest struct {
	*aws.Request
	Input *UpdateAssetPropertyInput
	Copy  func(*UpdateAssetPropertyInput) UpdateAssetPropertyRequest
}

UpdateAssetPropertyRequest is the request type for the UpdateAssetProperty API operation.

func (UpdateAssetPropertyRequest) Send 

func (r UpdateAssetPropertyRequest) Send(ctx context.Context) (*UpdateAssetPropertyResponse, error)

Send marshals and sends the UpdateAssetProperty API request.

type UpdateAssetPropertyResponse 

type UpdateAssetPropertyResponse struct {
	*UpdateAssetPropertyOutput
	// contains filtered or unexported fields
}

UpdateAssetPropertyResponse is the response type for the UpdateAssetProperty API operation.

func (*UpdateAssetPropertyResponse) SDKResponseMetdata 

func (r *UpdateAssetPropertyResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateAssetProperty request.

type UpdateAssetRequest 

type UpdateAssetRequest struct {
	*aws.Request
	Input *UpdateAssetInput
	Copy  func(*UpdateAssetInput) UpdateAssetRequest
}

UpdateAssetRequest is the request type for the UpdateAsset API operation.

func (UpdateAssetRequest) Send 

func (r UpdateAssetRequest) Send(ctx context.Context) (*UpdateAssetResponse, error)

Send marshals and sends the UpdateAsset API request.

type UpdateAssetResponse 

type UpdateAssetResponse struct {
	*UpdateAssetOutput
	// contains filtered or unexported fields
}

UpdateAssetResponse is the response type for the UpdateAsset API operation.

func (*UpdateAssetResponse) SDKResponseMetdata 

func (r *UpdateAssetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateAsset request.

type UpdateDashboardInput 

type UpdateDashboardInput 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 new dashboard definition, as 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 AWS IoT SiteWise User Guide.
	//
	// DashboardDefinition is a required field
	DashboardDefinition *string `locationName:"dashboardDefinition" type:"string" required:"true"`

	// A new description for the dashboard.
	DashboardDescription *string `locationName:"dashboardDescription" min:"1" type:"string"`

	// The ID of the dashboard to update.
	//
	// DashboardId is a required field
	DashboardId *string `location:"uri" locationName:"dashboardId" min:"36" type:"string" required:"true"`

	// A new friendly name for the dashboard.
	//
	// DashboardName is a required field
	DashboardName *string `locationName:"dashboardName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateDashboardInput) MarshalFields 

func (s UpdateDashboardInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateDashboardInput) String 

func (s UpdateDashboardInput) String() string

String returns the string representation

func (*UpdateDashboardInput) Validate 

func (s *UpdateDashboardInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDashboardOutput 

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

func (UpdateDashboardOutput) MarshalFields 

func (s UpdateDashboardOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateDashboardOutput) String 

func (s UpdateDashboardOutput) String() string

String returns the string representation

type UpdateDashboardRequest 

type UpdateDashboardRequest struct {
	*aws.Request
	Input *UpdateDashboardInput
	Copy  func(*UpdateDashboardInput) UpdateDashboardRequest
}

UpdateDashboardRequest is the request type for the UpdateDashboard API operation.

func (UpdateDashboardRequest) Send 

func (r UpdateDashboardRequest) Send(ctx context.Context) (*UpdateDashboardResponse, error)

Send marshals and sends the UpdateDashboard API request.

type UpdateDashboardResponse 

type UpdateDashboardResponse struct {
	*UpdateDashboardOutput
	// contains filtered or unexported fields
}

UpdateDashboardResponse is the response type for the UpdateDashboard API operation.

func (*UpdateDashboardResponse) SDKResponseMetdata 

func (r *UpdateDashboardResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateDashboard request.

type UpdateGatewayCapabilityConfigurationInput 

type UpdateGatewayCapabilityConfigurationInput struct {

	// The JSON document that defines the configuration for the gateway capability.
	// 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 AWS 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 configuration to be updated. For
	// example, if you configure OPC-UA sources from the AWS IoT SiteWise console,
	// your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version,
	// where version is a number such as 1.
	//
	// CapabilityNamespace is a required field
	CapabilityNamespace *string `locationName:"capabilityNamespace" min:"1" type:"string" required:"true"`

	// The ID of the gateway to be updated.
	//
	// GatewayId is a required field
	GatewayId *string `location:"uri" locationName:"gatewayId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateGatewayCapabilityConfigurationInput) MarshalFields 

func (s UpdateGatewayCapabilityConfigurationInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateGatewayCapabilityConfigurationInput) String 

func (s UpdateGatewayCapabilityConfigurationInput) String() string

String returns the string representation

func (*UpdateGatewayCapabilityConfigurationInput) Validate 

func (s *UpdateGatewayCapabilityConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateGatewayCapabilityConfigurationOutput 

type UpdateGatewayCapabilityConfigurationOutput struct {

	// 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.
	//
	// After you update a capability configuration, its sync status is OUT_OF_SYNC
	// until the gateway receives and applies or rejects the updated configuration.
	//
	// CapabilitySyncStatus is a required field
	CapabilitySyncStatus CapabilitySyncStatus `locationName:"capabilitySyncStatus" type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

func (UpdateGatewayCapabilityConfigurationOutput) MarshalFields 

func (s UpdateGatewayCapabilityConfigurationOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateGatewayCapabilityConfigurationOutput) String 

func (s UpdateGatewayCapabilityConfigurationOutput) String() string

String returns the string representation

type UpdateGatewayCapabilityConfigurationRequest 

type UpdateGatewayCapabilityConfigurationRequest struct {
	*aws.Request
	Input *UpdateGatewayCapabilityConfigurationInput
	Copy  func(*UpdateGatewayCapabilityConfigurationInput) UpdateGatewayCapabilityConfigurationRequest
}

UpdateGatewayCapabilityConfigurationRequest is the request type for the UpdateGatewayCapabilityConfiguration API operation.

func (UpdateGatewayCapabilityConfigurationRequest) Send 

func (r UpdateGatewayCapabilityConfigurationRequest) Send(ctx context.Context) (*UpdateGatewayCapabilityConfigurationResponse, error)

Send marshals and sends the UpdateGatewayCapabilityConfiguration API request.

type UpdateGatewayCapabilityConfigurationResponse 

type UpdateGatewayCapabilityConfigurationResponse struct {
	*UpdateGatewayCapabilityConfigurationOutput
	// contains filtered or unexported fields
}

UpdateGatewayCapabilityConfigurationResponse is the response type for the UpdateGatewayCapabilityConfiguration API operation.

func (*UpdateGatewayCapabilityConfigurationResponse) SDKResponseMetdata 

func (r *UpdateGatewayCapabilityConfigurationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateGatewayCapabilityConfiguration request.

type UpdateGatewayInput 

type UpdateGatewayInput struct {

	// The ID of the gateway to update.
	//
	// GatewayId is a required field
	GatewayId *string `location:"uri" locationName:"gatewayId" min:"36" type:"string" required:"true"`

	// A unique, friendly name for the gateway.
	//
	// GatewayName is a required field
	GatewayName *string `locationName:"gatewayName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateGatewayInput) MarshalFields 

func (s UpdateGatewayInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateGatewayInput) String 

func (s UpdateGatewayInput) String() string

String returns the string representation

func (*UpdateGatewayInput) Validate 

func (s *UpdateGatewayInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateGatewayOutput 

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

func (UpdateGatewayOutput) MarshalFields 

func (s UpdateGatewayOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateGatewayOutput) String 

func (s UpdateGatewayOutput) String() string

String returns the string representation

type UpdateGatewayRequest 

type UpdateGatewayRequest struct {
	*aws.Request
	Input *UpdateGatewayInput
	Copy  func(*UpdateGatewayInput) UpdateGatewayRequest
}

UpdateGatewayRequest is the request type for the UpdateGateway API operation.

func (UpdateGatewayRequest) Send 

func (r UpdateGatewayRequest) Send(ctx context.Context) (*UpdateGatewayResponse, error)

Send marshals and sends the UpdateGateway API request.

type UpdateGatewayResponse 

type UpdateGatewayResponse struct {
	*UpdateGatewayOutput
	// contains filtered or unexported fields
}

UpdateGatewayResponse is the response type for the UpdateGateway API operation.

func (*UpdateGatewayResponse) SDKResponseMetdata 

func (r *UpdateGatewayResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateGateway request.

type UpdatePortalInput 

type UpdatePortalInput 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 AWS administrator's contact email address.
	//
	// PortalContactEmail is a required field
	PortalContactEmail *string `locationName:"portalContactEmail" min:"1" type:"string" required:"true"`

	// A new description for the portal.
	PortalDescription *string `locationName:"portalDescription" min:"1" type:"string"`

	// The ID of the portal to update.
	//
	// PortalId is a required field
	PortalId *string `location:"uri" locationName:"portalId" min:"36" type:"string" required:"true"`

	// 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.
	PortalLogoImage *Image `locationName:"portalLogoImage" type:"structure"`

	// A new 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 AWS IoT SiteWise
	// resources on your behalf. For more information, see Using service roles for
	// AWS IoT SiteWise Monitor (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html)
	// in the AWS IoT SiteWise User Guide.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdatePortalInput) MarshalFields 

func (s UpdatePortalInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdatePortalInput) String 

func (s UpdatePortalInput) String() string

String returns the string representation

func (*UpdatePortalInput) Validate 

func (s *UpdatePortalInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdatePortalOutput 

type UpdatePortalOutput struct {

	// The status of the portal, which contains a state (UPDATING 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 (UpdatePortalOutput) MarshalFields 

func (s UpdatePortalOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdatePortalOutput) String 

func (s UpdatePortalOutput) String() string

String returns the string representation

type UpdatePortalRequest 

type UpdatePortalRequest struct {
	*aws.Request
	Input *UpdatePortalInput
	Copy  func(*UpdatePortalInput) UpdatePortalRequest
}

UpdatePortalRequest is the request type for the UpdatePortal API operation.

func (UpdatePortalRequest) Send 

func (r UpdatePortalRequest) Send(ctx context.Context) (*UpdatePortalResponse, error)

Send marshals and sends the UpdatePortal API request.

type UpdatePortalResponse 

type UpdatePortalResponse struct {
	*UpdatePortalOutput
	// contains filtered or unexported fields
}

UpdatePortalResponse is the response type for the UpdatePortal API operation.

func (*UpdatePortalResponse) SDKResponseMetdata 

func (r *UpdatePortalResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdatePortal request.

type UpdateProjectInput 

type UpdateProjectInput 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"`

	// A new description for the project.
	ProjectDescription *string `locationName:"projectDescription" min:"1" type:"string"`

	// The ID of the project to update.
	//
	// ProjectId is a required field
	ProjectId *string `location:"uri" locationName:"projectId" min:"36" type:"string" required:"true"`

	// A new friendly name for the project.
	//
	// ProjectName is a required field
	ProjectName *string `locationName:"projectName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateProjectInput) MarshalFields 

func (s UpdateProjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateProjectInput) String 

func (s UpdateProjectInput) String() string

String returns the string representation

func (*UpdateProjectInput) Validate 

func (s *UpdateProjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateProjectOutput 

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

func (UpdateProjectOutput) MarshalFields 

func (s UpdateProjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateProjectOutput) String 

func (s UpdateProjectOutput) String() string

String returns the string representation

type UpdateProjectRequest 

type UpdateProjectRequest struct {
	*aws.Request
	Input *UpdateProjectInput
	Copy  func(*UpdateProjectInput) UpdateProjectRequest
}

UpdateProjectRequest is the request type for the UpdateProject API operation.

func (UpdateProjectRequest) Send 

func (r UpdateProjectRequest) Send(ctx context.Context) (*UpdateProjectResponse, error)

Send marshals and sends the UpdateProject API request.

type UpdateProjectResponse 

type UpdateProjectResponse struct {
	*UpdateProjectOutput
	// contains filtered or unexported fields
}

UpdateProjectResponse is the response type for the UpdateProject API operation.

func (*UpdateProjectResponse) SDKResponseMetdata 

func (r *UpdateProjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateProject request.

type UserIdentity 

type UserIdentity struct {

	// The AWS SSO ID of the user.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains information for a user identity in an access policy.

func (UserIdentity) MarshalFields 

func (s UserIdentity) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UserIdentity) String 

func (s UserIdentity) String() string

String returns the string representation

func (*UserIdentity) Validate 

func (s *UserIdentity) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type VariableValue 

type VariableValue struct {

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

	// The ID of the property to use as the variable. You can use the property name
	// if it's from the same asset model.
	//
	// PropertyId is a required field
	PropertyId *string `locationName:"propertyId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Identifies a property value used in an expression.

func (VariableValue) MarshalFields 

func (s VariableValue) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (VariableValue) String 

func (s VariableValue) String() string

String returns the string representation

func (*VariableValue) Validate 

func (s *VariableValue) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Variant 

type Variant struct {

	// Asset property data of type Boolean (true or false).
	BooleanValue *bool `locationName:"booleanValue" type:"boolean"`

	// Asset property data of type double (floating point number).
	DoubleValue *float64 `locationName:"doubleValue" type:"double"`

	// Asset property data of type integer (whole number).
	IntegerValue *int64 `locationName:"integerValue" type:"integer"`

	// Asset property data of type string (sequence of characters).
	StringValue *string `locationName:"stringValue" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (Variant) MarshalFields 

func (s Variant) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Variant) String 

func (s Variant) String() string

String returns the string representation

func (*Variant) Validate 

func (s *Variant) Validate() error

Validate inspects the fields of the type to determine if they are valid.

Source Files

View all Source files

Directories

Path Synopsis
Package iotsitewiseiface provides an interface to enable mocking the AWS IoT SiteWise service client for testing your code.
 Package iotsitewiseiface provides an interface to enable mocking the AWS IoT SiteWise service client for testing your code.

Jump to

Keyboard shortcuts

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