package iotsitewise
import "github.com/aws/aws-sdk-go-v2/service/iotsitewise"
Index ¶
- Constants
- func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
- type AssociateAssetsInput
- type AssociateAssetsOutput
- type BatchAssociateProjectAssetsInput
- type BatchAssociateProjectAssetsOutput
- type BatchDisassociateProjectAssetsInput
- type BatchDisassociateProjectAssetsOutput
- type BatchPutAssetPropertyValueInput
- type BatchPutAssetPropertyValueOutput
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) AssociateAssets(ctx context.Context, params *AssociateAssetsInput, optFns ...func(*Options)) (*AssociateAssetsOutput, error)
- func (c *Client) BatchAssociateProjectAssets(ctx context.Context, params *BatchAssociateProjectAssetsInput, optFns ...func(*Options)) (*BatchAssociateProjectAssetsOutput, error)
- func (c *Client) BatchDisassociateProjectAssets(ctx context.Context, params *BatchDisassociateProjectAssetsInput, optFns ...func(*Options)) (*BatchDisassociateProjectAssetsOutput, error)
- func (c *Client) BatchPutAssetPropertyValue(ctx context.Context, params *BatchPutAssetPropertyValueInput, optFns ...func(*Options)) (*BatchPutAssetPropertyValueOutput, error)
- func (c *Client) CreateAccessPolicy(ctx context.Context, params *CreateAccessPolicyInput, optFns ...func(*Options)) (*CreateAccessPolicyOutput, error)
- func (c *Client) CreateAsset(ctx context.Context, params *CreateAssetInput, optFns ...func(*Options)) (*CreateAssetOutput, error)
- func (c *Client) CreateAssetModel(ctx context.Context, params *CreateAssetModelInput, optFns ...func(*Options)) (*CreateAssetModelOutput, error)
- func (c *Client) CreateDashboard(ctx context.Context, params *CreateDashboardInput, optFns ...func(*Options)) (*CreateDashboardOutput, error)
- func (c *Client) CreateGateway(ctx context.Context, params *CreateGatewayInput, optFns ...func(*Options)) (*CreateGatewayOutput, error)
- func (c *Client) CreatePortal(ctx context.Context, params *CreatePortalInput, optFns ...func(*Options)) (*CreatePortalOutput, error)
- func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, optFns ...func(*Options)) (*CreateProjectOutput, error)
- func (c *Client) DeleteAccessPolicy(ctx context.Context, params *DeleteAccessPolicyInput, optFns ...func(*Options)) (*DeleteAccessPolicyOutput, error)
- func (c *Client) DeleteAsset(ctx context.Context, params *DeleteAssetInput, optFns ...func(*Options)) (*DeleteAssetOutput, error)
- func (c *Client) DeleteAssetModel(ctx context.Context, params *DeleteAssetModelInput, optFns ...func(*Options)) (*DeleteAssetModelOutput, error)
- func (c *Client) DeleteDashboard(ctx context.Context, params *DeleteDashboardInput, optFns ...func(*Options)) (*DeleteDashboardOutput, error)
- func (c *Client) DeleteGateway(ctx context.Context, params *DeleteGatewayInput, optFns ...func(*Options)) (*DeleteGatewayOutput, error)
- func (c *Client) DeletePortal(ctx context.Context, params *DeletePortalInput, optFns ...func(*Options)) (*DeletePortalOutput, error)
- func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error)
- func (c *Client) DescribeAccessPolicy(ctx context.Context, params *DescribeAccessPolicyInput, optFns ...func(*Options)) (*DescribeAccessPolicyOutput, error)
- func (c *Client) DescribeAsset(ctx context.Context, params *DescribeAssetInput, optFns ...func(*Options)) (*DescribeAssetOutput, error)
- func (c *Client) DescribeAssetModel(ctx context.Context, params *DescribeAssetModelInput, optFns ...func(*Options)) (*DescribeAssetModelOutput, error)
- func (c *Client) DescribeAssetProperty(ctx context.Context, params *DescribeAssetPropertyInput, optFns ...func(*Options)) (*DescribeAssetPropertyOutput, error)
- func (c *Client) DescribeDashboard(ctx context.Context, params *DescribeDashboardInput, optFns ...func(*Options)) (*DescribeDashboardOutput, error)
- func (c *Client) DescribeGateway(ctx context.Context, params *DescribeGatewayInput, optFns ...func(*Options)) (*DescribeGatewayOutput, error)
- func (c *Client) DescribeGatewayCapabilityConfiguration(ctx context.Context, params *DescribeGatewayCapabilityConfigurationInput, optFns ...func(*Options)) (*DescribeGatewayCapabilityConfigurationOutput, error)
- func (c *Client) DescribeLoggingOptions(ctx context.Context, params *DescribeLoggingOptionsInput, optFns ...func(*Options)) (*DescribeLoggingOptionsOutput, error)
- func (c *Client) DescribePortal(ctx context.Context, params *DescribePortalInput, optFns ...func(*Options)) (*DescribePortalOutput, error)
- func (c *Client) DescribeProject(ctx context.Context, params *DescribeProjectInput, optFns ...func(*Options)) (*DescribeProjectOutput, error)
- func (c *Client) DisassociateAssets(ctx context.Context, params *DisassociateAssetsInput, optFns ...func(*Options)) (*DisassociateAssetsOutput, error)
- func (c *Client) GetAssetPropertyAggregates(ctx context.Context, params *GetAssetPropertyAggregatesInput, optFns ...func(*Options)) (*GetAssetPropertyAggregatesOutput, error)
- func (c *Client) GetAssetPropertyValue(ctx context.Context, params *GetAssetPropertyValueInput, optFns ...func(*Options)) (*GetAssetPropertyValueOutput, error)
- func (c *Client) GetAssetPropertyValueHistory(ctx context.Context, params *GetAssetPropertyValueHistoryInput, optFns ...func(*Options)) (*GetAssetPropertyValueHistoryOutput, error)
- func (c *Client) ListAccessPolicies(ctx context.Context, params *ListAccessPoliciesInput, optFns ...func(*Options)) (*ListAccessPoliciesOutput, error)
- func (c *Client) ListAssetModels(ctx context.Context, params *ListAssetModelsInput, optFns ...func(*Options)) (*ListAssetModelsOutput, error)
- func (c *Client) ListAssets(ctx context.Context, params *ListAssetsInput, optFns ...func(*Options)) (*ListAssetsOutput, error)
- func (c *Client) ListAssociatedAssets(ctx context.Context, params *ListAssociatedAssetsInput, optFns ...func(*Options)) (*ListAssociatedAssetsOutput, error)
- func (c *Client) ListDashboards(ctx context.Context, params *ListDashboardsInput, optFns ...func(*Options)) (*ListDashboardsOutput, error)
- func (c *Client) ListGateways(ctx context.Context, params *ListGatewaysInput, optFns ...func(*Options)) (*ListGatewaysOutput, error)
- func (c *Client) ListPortals(ctx context.Context, params *ListPortalsInput, optFns ...func(*Options)) (*ListPortalsOutput, error)
- func (c *Client) ListProjectAssets(ctx context.Context, params *ListProjectAssetsInput, optFns ...func(*Options)) (*ListProjectAssetsOutput, error)
- func (c *Client) ListProjects(ctx context.Context, params *ListProjectsInput, optFns ...func(*Options)) (*ListProjectsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
- func (c *Client) PutLoggingOptions(ctx context.Context, params *PutLoggingOptionsInput, optFns ...func(*Options)) (*PutLoggingOptionsOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateAccessPolicy(ctx context.Context, params *UpdateAccessPolicyInput, optFns ...func(*Options)) (*UpdateAccessPolicyOutput, error)
- func (c *Client) UpdateAsset(ctx context.Context, params *UpdateAssetInput, optFns ...func(*Options)) (*UpdateAssetOutput, error)
- func (c *Client) UpdateAssetModel(ctx context.Context, params *UpdateAssetModelInput, optFns ...func(*Options)) (*UpdateAssetModelOutput, error)
- func (c *Client) UpdateAssetProperty(ctx context.Context, params *UpdateAssetPropertyInput, optFns ...func(*Options)) (*UpdateAssetPropertyOutput, error)
- func (c *Client) UpdateDashboard(ctx context.Context, params *UpdateDashboardInput, optFns ...func(*Options)) (*UpdateDashboardOutput, error)
- func (c *Client) UpdateGateway(ctx context.Context, params *UpdateGatewayInput, optFns ...func(*Options)) (*UpdateGatewayOutput, error)
- func (c *Client) UpdateGatewayCapabilityConfiguration(ctx context.Context, params *UpdateGatewayCapabilityConfigurationInput, optFns ...func(*Options)) (*UpdateGatewayCapabilityConfigurationOutput, error)
- func (c *Client) UpdatePortal(ctx context.Context, params *UpdatePortalInput, optFns ...func(*Options)) (*UpdatePortalOutput, error)
- func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, optFns ...func(*Options)) (*UpdateProjectOutput, error)
- type CreateAccessPolicyInput
- type CreateAccessPolicyOutput
- type CreateAssetInput
- type CreateAssetModelInput
- type CreateAssetModelOutput
- type CreateAssetOutput
- type CreateDashboardInput
- type CreateDashboardOutput
- type CreateGatewayInput
- type CreateGatewayOutput
- type CreatePortalInput
- type CreatePortalOutput
- type CreateProjectInput
- type CreateProjectOutput
- type DeleteAccessPolicyInput
- type DeleteAccessPolicyOutput
- type DeleteAssetInput
- type DeleteAssetModelInput
- type DeleteAssetModelOutput
- type DeleteAssetOutput
- type DeleteDashboardInput
- type DeleteDashboardOutput
- type DeleteGatewayInput
- type DeleteGatewayOutput
- type DeletePortalInput
- type DeletePortalOutput
- type DeleteProjectInput
- type DeleteProjectOutput
- type DescribeAccessPolicyInput
- type DescribeAccessPolicyOutput
- type DescribeAssetInput
- type DescribeAssetModelInput
- type DescribeAssetModelOutput
- type DescribeAssetOutput
- type DescribeAssetPropertyInput
- type DescribeAssetPropertyOutput
- type DescribeDashboardInput
- type DescribeDashboardOutput
- type DescribeGatewayCapabilityConfigurationInput
- type DescribeGatewayCapabilityConfigurationOutput
- type DescribeGatewayInput
- type DescribeGatewayOutput
- type DescribeLoggingOptionsInput
- type DescribeLoggingOptionsOutput
- type DescribePortalInput
- type DescribePortalOutput
- type DescribeProjectInput
- type DescribeProjectOutput
- type DisassociateAssetsInput
- type DisassociateAssetsOutput
- type EndpointResolver
- type EndpointResolverFunc
- type GetAssetPropertyAggregatesInput
- type GetAssetPropertyAggregatesOutput
- type GetAssetPropertyValueHistoryInput
- type GetAssetPropertyValueHistoryOutput
- type GetAssetPropertyValueInput
- type GetAssetPropertyValueOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListAccessPoliciesInput
- type ListAccessPoliciesOutput
- type ListAssetModelsInput
- type ListAssetModelsOutput
- type ListAssetsInput
- type ListAssetsOutput
- type ListAssociatedAssetsInput
- type ListAssociatedAssetsOutput
- type ListDashboardsInput
- type ListDashboardsOutput
- type ListGatewaysInput
- type ListGatewaysOutput
- type ListPortalsInput
- type ListPortalsOutput
- type ListProjectAssetsInput
- type ListProjectAssetsOutput
- type ListProjectsInput
- type ListProjectsOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- func (o Options) Copy() Options
- func (o Options) GetCredentials() aws.CredentialsProvider
- func (o Options) GetEndpointOptions() ResolverOptions
- func (o Options) GetEndpointResolver() EndpointResolver
- func (o Options) GetHTTPSignerV4() HTTPSignerV4
- func (o Options) GetIdempotencyTokenProvider() IdempotencyTokenProvider
- func (o Options) GetRegion() string
- func (o Options) GetRetryer() retry.Retryer
- type PutLoggingOptionsInput
- type PutLoggingOptionsOutput
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type ResolveEndpointMiddlewareOptions
- type ResolverOptions
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateAccessPolicyInput
- type UpdateAccessPolicyOutput
- type UpdateAssetInput
- type UpdateAssetModelInput
- type UpdateAssetModelOutput
- type UpdateAssetOutput
- type UpdateAssetPropertyInput
- type UpdateAssetPropertyOutput
- type UpdateDashboardInput
- type UpdateDashboardOutput
- type UpdateGatewayCapabilityConfigurationInput
- type UpdateGatewayCapabilityConfigurationOutput
- type UpdateGatewayInput
- type UpdateGatewayOutput
- type UpdatePortalInput
- type UpdatePortalOutput
- type UpdateProjectInput
- type UpdateProjectOutput
Constants ¶
const ServiceAPIVersion = "2019-12-02"
const ServiceID = "IoTSiteWise"
Functions ¶
func AddResolveEndpointMiddleware ¶
func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func RemoveResolveEndpointMiddleware ¶
func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
Types ¶
type AssociateAssetsInput ¶
type AssociateAssetsInput struct { // The ID of the child asset to be associated. // // This member is required. ChildAssetId *string // 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. // // This member is required. HierarchyId *string // A unique case-sensitive identifier that you can provide to ensure the // idempotency of the request. Don't reuse this client token if a new idempotent // request is required. ClientToken *string // The ID of the parent asset. // // This member is required. AssetId *string }
type AssociateAssetsOutput ¶
type AssociateAssetsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type BatchAssociateProjectAssetsInput ¶
type BatchAssociateProjectAssetsInput struct { // The IDs of the assets to be associated to the project. // // This member is required. AssetIds []*string // The ID of the project to which to associate the assets. // // This member is required. ProjectId *string // A unique case-sensitive identifier that you can provide to ensure the // idempotency of the request. Don't reuse this client token if a new idempotent // request is required. ClientToken *string }
type BatchAssociateProjectAssetsOutput ¶
type BatchAssociateProjectAssetsOutput struct { // A list of associated error information, if any. Errors []*types.AssetErrorDetails // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type BatchDisassociateProjectAssetsInput ¶
type BatchDisassociateProjectAssetsInput struct { // The ID of the project from which to disassociate the assets. // // This member is required. ProjectId *string // The IDs of the assets to be disassociated from the project. // // This member is required. AssetIds []*string // A unique case-sensitive identifier that you can provide to ensure the // idempotency of the request. Don't reuse this client token if a new idempotent // request is required. ClientToken *string }
type BatchDisassociateProjectAssetsOutput ¶
type BatchDisassociateProjectAssetsOutput struct { // A list of associated error information, if any. Errors []*types.AssetErrorDetails // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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. // // This member is required. Entries []*types.PutAssetPropertyValueEntry }
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. // // This member is required. ErrorEntries []*types.BatchPutAssetPropertyErrorEntry // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
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.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AssociateAssets ¶
func (c *Client) AssociateAssets(ctx context.Context, params *AssociateAssetsInput, optFns ...func(*Options)) (*AssociateAssetsOutput, error)
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.
func (*Client) BatchAssociateProjectAssets ¶
func (c *Client) BatchAssociateProjectAssets(ctx context.Context, params *BatchAssociateProjectAssetsInput, optFns ...func(*Options)) (*BatchAssociateProjectAssetsOutput, error)
Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.
func (*Client) BatchDisassociateProjectAssets ¶
func (c *Client) BatchDisassociateProjectAssets(ctx context.Context, params *BatchDisassociateProjectAssetsInput, optFns ...func(*Options)) (*BatchDisassociateProjectAssetsOutput, error)
Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.
func (*Client) BatchPutAssetPropertyValue ¶
func (c *Client) BatchPutAssetPropertyValue(ctx context.Context, params *BatchPutAssetPropertyValueInput, optFns ...func(*Options)) (*BatchPutAssetPropertyValueOutput, error)
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:
- The assetId and propertyId of an asset property.
* A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html).
With respect to Unix epoch time, 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.
func (*Client) CreateAccessPolicy ¶
func (c *Client) CreateAccessPolicy(ctx context.Context, params *CreateAccessPolicyInput, optFns ...func(*Options)) (*CreateAccessPolicyOutput, error)
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.
func (*Client) CreateAsset ¶
func (c *Client) CreateAsset(ctx context.Context, params *CreateAssetInput, optFns ...func(*Options)) (*CreateAssetOutput, error)
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.
func (*Client) CreateAssetModel ¶
func (c *Client) CreateAssetModel(ctx context.Context, params *CreateAssetModelInput, optFns ...func(*Options)) (*CreateAssetModelOutput, error)
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.
func (*Client) CreateDashboard ¶
func (c *Client) CreateDashboard(ctx context.Context, params *CreateDashboardInput, optFns ...func(*Options)) (*CreateDashboardOutput, error)
Creates a dashboard in an AWS IoT SiteWise Monitor project.
func (*Client) CreateGateway ¶
func (c *Client) CreateGateway(ctx context.Context, params *CreateGatewayInput, optFns ...func(*Options)) (*CreateGatewayOutput, error)
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.
func (*Client) CreatePortal ¶
func (c *Client) CreatePortal(ctx context.Context, params *CreatePortalInput, optFns ...func(*Options)) (*CreatePortalOutput, error)
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.
func (*Client) CreateProject ¶
func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, optFns ...func(*Options)) (*CreateProjectOutput, error)
Creates a project in the specified portal.
func (*Client) DeleteAccessPolicy ¶
func (c *Client) DeleteAccessPolicy(ctx context.Context, params *DeleteAccessPolicyInput, optFns ...func(*Options)) (*DeleteAccessPolicyOutput, error)
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.
func (*Client) DeleteAsset ¶
func (c *Client) DeleteAsset(ctx context.Context, params *DeleteAssetInput, optFns ...func(*Options)) (*DeleteAssetOutput, error)
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).
func (*Client) DeleteAssetModel ¶
func (c *Client) DeleteAssetModel(ctx context.Context, params *DeleteAssetModelInput, optFns ...func(*Options)) (*DeleteAssetModelOutput, error)
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.
func (*Client) DeleteDashboard ¶
func (c *Client) DeleteDashboard(ctx context.Context, params *DeleteDashboardInput, optFns ...func(*Options)) (*DeleteDashboardOutput, error)
Deletes a dashboard from AWS IoT SiteWise Monitor.
func (*Client) DeleteGateway ¶
func (c *Client) DeleteGateway(ctx context.Context, params *DeleteGatewayInput, optFns ...func(*Options)) (*DeleteGatewayOutput, error)
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.
func (*Client) DeletePortal ¶
func (c *Client) DeletePortal(ctx context.Context, params *DeletePortalInput, optFns ...func(*Options)) (*DeletePortalOutput, error)
Deletes a portal from AWS IoT SiteWise Monitor.
func (*Client) DeleteProject ¶
func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error)
Deletes a project from AWS IoT SiteWise Monitor.
func (*Client) DescribeAccessPolicy ¶
func (c *Client) DescribeAccessPolicy(ctx context.Context, params *DescribeAccessPolicyInput, optFns ...func(*Options)) (*DescribeAccessPolicyOutput, error)
Describes an access policy, which specifies an AWS SSO user or group's access to an AWS IoT SiteWise Monitor portal or project.
func (*Client) DescribeAsset ¶
func (c *Client) DescribeAsset(ctx context.Context, params *DescribeAssetInput, optFns ...func(*Options)) (*DescribeAssetOutput, error)
Retrieves information about an asset.
func (*Client) DescribeAssetModel ¶
func (c *Client) DescribeAssetModel(ctx context.Context, params *DescribeAssetModelInput, optFns ...func(*Options)) (*DescribeAssetModelOutput, error)
Retrieves information about an asset model.
func (*Client) DescribeAssetProperty ¶
func (c *Client) DescribeAssetProperty(ctx context.Context, params *DescribeAssetPropertyInput, optFns ...func(*Options)) (*DescribeAssetPropertyOutput, error)
Retrieves information about an asset's property.
func (*Client) DescribeDashboard ¶
func (c *Client) DescribeDashboard(ctx context.Context, params *DescribeDashboardInput, optFns ...func(*Options)) (*DescribeDashboardOutput, error)
Retrieves information about a dashboard.
func (*Client) DescribeGateway ¶
func (c *Client) DescribeGateway(ctx context.Context, params *DescribeGatewayInput, optFns ...func(*Options)) (*DescribeGatewayOutput, error)
Retrieves information about a gateway.
func (*Client) DescribeGatewayCapabilityConfiguration ¶
func (c *Client) DescribeGatewayCapabilityConfiguration(ctx context.Context, params *DescribeGatewayCapabilityConfigurationInput, optFns ...func(*Options)) (*DescribeGatewayCapabilityConfigurationOutput, error)
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).
func (*Client) DescribeLoggingOptions ¶
func (c *Client) DescribeLoggingOptions(ctx context.Context, params *DescribeLoggingOptionsInput, optFns ...func(*Options)) (*DescribeLoggingOptionsOutput, error)
Retrieves the current AWS IoT SiteWise logging options.
func (*Client) DescribePortal ¶
func (c *Client) DescribePortal(ctx context.Context, params *DescribePortalInput, optFns ...func(*Options)) (*DescribePortalOutput, error)
Retrieves information about a portal.
func (*Client) DescribeProject ¶
func (c *Client) DescribeProject(ctx context.Context, params *DescribeProjectInput, optFns ...func(*Options)) (*DescribeProjectOutput, error)
Retrieves information about a project.
func (*Client) DisassociateAssets ¶
func (c *Client) DisassociateAssets(ctx context.Context, params *DisassociateAssetsInput, optFns ...func(*Options)) (*DisassociateAssetsOutput, error)
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
func (*Client) GetAssetPropertyAggregates ¶
func (c *Client) GetAssetPropertyAggregates(ctx context.Context, params *GetAssetPropertyAggregatesInput, optFns ...func(*Options)) (*GetAssetPropertyAggregatesOutput, error)
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).
func (*Client) GetAssetPropertyValue ¶
func (c *Client) GetAssetPropertyValue(ctx context.Context, params *GetAssetPropertyValueInput, optFns ...func(*Options)) (*GetAssetPropertyValueOutput, error)
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).
func (*Client) GetAssetPropertyValueHistory ¶
func (c *Client) GetAssetPropertyValueHistory(ctx context.Context, params *GetAssetPropertyValueHistoryInput, optFns ...func(*Options)) (*GetAssetPropertyValueHistoryOutput, error)
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).
func (*Client) ListAccessPolicies ¶
func (c *Client) ListAccessPolicies(ctx context.Context, params *ListAccessPoliciesInput, optFns ...func(*Options)) (*ListAccessPoliciesOutput, error)
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).
func (*Client) ListAssetModels ¶
func (c *Client) ListAssetModels(ctx context.Context, params *ListAssetModelsInput, optFns ...func(*Options)) (*ListAssetModelsOutput, error)
Retrieves a paginated list of summaries of all asset models.
func (*Client) ListAssets ¶
func (c *Client) ListAssets(ctx context.Context, params *ListAssetsInput, optFns ...func(*Options)) (*ListAssetsOutput, error)
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.
func (*Client) ListAssociatedAssets ¶
func (c *Client) ListAssociatedAssets(ctx context.Context, params *ListAssociatedAssetsInput, optFns ...func(*Options)) (*ListAssociatedAssetsOutput, error)
Retrieves a paginated list of the assets associated to a parent asset (assetId) by a given hierarchy (hierarchyId).
func (*Client) ListDashboards ¶
func (c *Client) ListDashboards(ctx context.Context, params *ListDashboardsInput, optFns ...func(*Options)) (*ListDashboardsOutput, error)
Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
func (*Client) ListGateways ¶
func (c *Client) ListGateways(ctx context.Context, params *ListGatewaysInput, optFns ...func(*Options)) (*ListGatewaysOutput, error)
Retrieves a paginated list of gateways.
func (*Client) ListPortals ¶
func (c *Client) ListPortals(ctx context.Context, params *ListPortalsInput, optFns ...func(*Options)) (*ListPortalsOutput, error)
Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
func (*Client) ListProjectAssets ¶
func (c *Client) ListProjectAssets(ctx context.Context, params *ListProjectAssetsInput, optFns ...func(*Options)) (*ListProjectAssetsOutput, error)
Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
func (*Client) ListProjects ¶
func (c *Client) ListProjects(ctx context.Context, params *ListProjectsInput, optFns ...func(*Options)) (*ListProjectsOutput, error)
Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Retrieves the list of tags for an AWS IoT SiteWise resource.
func (*Client) PutLoggingOptions ¶
func (c *Client) PutLoggingOptions(ctx context.Context, params *PutLoggingOptionsInput, optFns ...func(*Options)) (*PutLoggingOptionsOutput, error)
Sets logging options for AWS IoT SiteWise.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Adds tags to an AWS IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes a tag from an AWS IoT SiteWise resource.
func (*Client) UpdateAccessPolicy ¶
func (c *Client) UpdateAccessPolicy(ctx context.Context, params *UpdateAccessPolicyInput, optFns ...func(*Options)) (*UpdateAccessPolicyOutput, error)
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.
func (*Client) UpdateAsset ¶
func (c *Client) UpdateAsset(ctx context.Context, params *UpdateAssetInput, optFns ...func(*Options)) (*UpdateAssetOutput, error)
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.
func (*Client) UpdateAssetModel ¶
func (c *Client) UpdateAssetModel(ctx context.Context, params *UpdateAssetModelInput, optFns ...func(*Options)) (*UpdateAssetModelOutput, error)
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.
func (*Client) UpdateAssetProperty ¶
func (c *Client) UpdateAssetProperty(ctx context.Context, params *UpdateAssetPropertyInput, optFns ...func(*Options)) (*UpdateAssetPropertyOutput, error)
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).
func (*Client) UpdateDashboard ¶
func (c *Client) UpdateDashboard(ctx context.Context, params *UpdateDashboardInput, optFns ...func(*Options)) (*UpdateDashboardOutput, error)
Updates an AWS IoT SiteWise Monitor dashboard.
func (*Client) UpdateGateway ¶
func (c *Client) UpdateGateway(ctx context.Context, params *UpdateGatewayInput, optFns ...func(*Options)) (*UpdateGatewayOutput, error)
Updates a gateway's name.
func (*Client) UpdateGatewayCapabilityConfiguration ¶
func (c *Client) UpdateGatewayCapabilityConfiguration(ctx context.Context, params *UpdateGatewayCapabilityConfigurationInput, optFns ...func(*Options)) (*UpdateGatewayCapabilityConfigurationOutput, error)
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).
func (*Client) UpdatePortal ¶
func (c *Client) UpdatePortal(ctx context.Context, params *UpdatePortalInput, optFns ...func(*Options)) (*UpdatePortalOutput, error)
Updates an AWS IoT SiteWise Monitor portal.
func (*Client) UpdateProject ¶
func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, optFns ...func(*Options)) (*UpdateProjectOutput, error)
Updates an AWS IoT SiteWise Monitor project.
type CreateAccessPolicyInput ¶
type CreateAccessPolicyInput struct { // The identity for this access policy. Choose either a user or a group but not // both. // // This member is required. AccessPolicyIdentity *types.Identity // 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 // The AWS IoT SiteWise Monitor resource for this access policy. Choose either // portal or project but not both. // // This member is required. AccessPolicyResource *types.Resource // The permission level for this access policy. Note that a project ADMINISTRATOR // is also known as a project owner. // // This member is required. AccessPolicyPermission types.Permission // 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 }
type CreateAccessPolicyOutput ¶
type CreateAccessPolicyOutput struct { // The ID of the access policy. // // This member is required. AccessPolicyId *string // 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} // // This member is required. AccessPolicyArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateAssetInput ¶
type CreateAssetInput 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 // The ID of the asset model from which to create the asset. // // This member is required. AssetModelId *string // 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 // A unique, friendly name for the asset. // // This member is required. AssetName *string }
type CreateAssetModelInput ¶
type CreateAssetModelInput struct { // A description for the asset model. AssetModelDescription *string // 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 []*types.AssetModelPropertyDefinition // 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 // A unique, friendly name for the asset model. // // This member is required. AssetModelName *string // 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 // 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 []*types.AssetModelHierarchyDefinition }
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} // // This member is required. AssetModelArn *string // The status of the asset model, which contains a state (CREATING after // successfully calling this operation) and any error message. // // This member is required. AssetModelStatus *types.AssetModelStatus // The ID of the asset model. You can use this ID when you call other AWS IoT // SiteWise APIs. // // This member is required. AssetModelId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateAssetOutput ¶
type CreateAssetOutput struct { // 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. // // This member is required. AssetId *string // The status of the asset, which contains a state (CREATING after successfully // calling this operation) and any error message. // // This member is required. AssetStatus *types.AssetStatus // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the asset, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} // // This member is required. AssetArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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 // 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. // // This member is required. DashboardDefinition *string // 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 // A friendly name for the dashboard. // // This member is required. DashboardName *string // The ID of the project in which to create the dashboard. // // This member is required. ProjectId *string // A description for the dashboard. DashboardDescription *string }
type CreateDashboardOutput ¶
type CreateDashboardOutput struct { // The ID of the dashboard. // // This member is required. DashboardId *string // 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} // // This member is required. DashboardArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateGatewayInput ¶
type CreateGatewayInput struct { // The gateway's platform. You can only specify one platform in a gateway. // // This member is required. GatewayPlatform *types.GatewayPlatform // 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 // A unique, friendly name for the gateway. // // This member is required. GatewayName *string }
type CreateGatewayOutput ¶
type CreateGatewayOutput struct { // The ID of the gateway device. You can use this ID when you call other AWS IoT // SiteWise APIs. // // This member is required. GatewayId *string // 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} // // This member is required. GatewayArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreatePortalInput ¶
type CreatePortalInput struct { // 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 // A friendly name for the portal. // // This member is required. PortalName *string // A unique case-sensitive identifier that you can provide to ensure the // idempotency of the request. Don't reuse this client token if a new idempotent // request is required. ClientToken *string // 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. // // This member is required. RoleArn *string // The AWS administrator's contact email address. // // This member is required. PortalContactEmail *string // A logo image to display in the portal. Upload a square, high-resolution image. // The image is displayed on a dark background. PortalLogoImageFile *types.ImageFile // A description for the portal. PortalDescription *string }
type CreatePortalOutput ¶
type CreatePortalOutput struct { // The associated AWS SSO application Id. // // This member is required. SsoApplicationId *string // The status of the portal, which contains a state (CREATING after successfully // calling this operation) and any error message. // // This member is required. PortalStatus *types.PortalStatus // 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} // // This member is required. PortalArn *string // The public URL for the AWS IoT SiteWise Monitor portal. // // This member is required. PortalStartUrl *string // The ID of the created portal. // // This member is required. PortalId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateProjectInput ¶
type CreateProjectInput struct { // 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 // A description for the project. ProjectDescription *string // A friendly name for the project. // // This member is required. ProjectName *string // The ID of the portal in which to create the project. // // This member is required. PortalId *string // A unique case-sensitive identifier that you can provide to ensure the // idempotency of the request. Don't reuse this client token if a new idempotent // request is required. ClientToken *string }
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} // // This member is required. ProjectArn *string // The ID of the project. // // This member is required. ProjectId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteAccessPolicyInput ¶
type DeleteAccessPolicyInput struct { // The ID of the access policy to be deleted. // // This member is required. AccessPolicyId *string // A unique case-sensitive identifier that you can provide to ensure the // idempotency of the request. Don't reuse this client token if a new idempotent // request is required. ClientToken *string }
type DeleteAccessPolicyOutput ¶
type DeleteAccessPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteAssetInput ¶
type DeleteAssetInput 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 // The ID of the asset to delete. // // This member is required. AssetId *string }
type DeleteAssetModelInput ¶
type DeleteAssetModelInput 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 // The ID of the asset model to delete. // // This member is required. AssetModelId *string }
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. // // This member is required. AssetModelStatus *types.AssetModelStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteAssetOutput ¶
type DeleteAssetOutput struct { // The status of the asset, which contains a state (DELETING after successfully // calling this operation) and any error message. // // This member is required. AssetStatus *types.AssetStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteDashboardInput ¶
type DeleteDashboardInput struct { // The ID of the dashboard to delete. // // This member is required. DashboardId *string // A unique case-sensitive identifier that you can provide to ensure the // idempotency of the request. Don't reuse this client token if a new idempotent // request is required. ClientToken *string }
type DeleteDashboardOutput ¶
type DeleteDashboardOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteGatewayInput ¶
type DeleteGatewayInput struct { // The ID of the gateway to delete. // // This member is required. GatewayId *string }
type DeleteGatewayOutput ¶
type DeleteGatewayOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeletePortalInput ¶
type DeletePortalInput struct { // The ID of the portal to delete. // // This member is required. PortalId *string // A unique case-sensitive identifier that you can provide to ensure the // idempotency of the request. Don't reuse this client token if a new idempotent // request is required. ClientToken *string }
type DeletePortalOutput ¶
type DeletePortalOutput struct { // The status of the portal, which contains a state (DELETING after successfully // calling this operation) and any error message. // // This member is required. PortalStatus *types.PortalStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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 // The ID of the project. // // This member is required. ProjectId *string }
type DeleteProjectOutput ¶
type DeleteProjectOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeAccessPolicyInput ¶
type DescribeAccessPolicyInput struct { // The ID of the access policy. // // This member is required. AccessPolicyId *string }
type DescribeAccessPolicyOutput ¶
type DescribeAccessPolicyOutput struct { // The date the access policy was created, in Unix epoch time. // // This member is required. AccessPolicyCreationDate *time.Time // The date the access policy was last updated, in Unix epoch time. // // This member is required. AccessPolicyLastUpdateDate *time.Time // The access policy permission. Note that a project ADMINISTRATOR is also known as // a project owner. // // This member is required. AccessPolicyPermission types.Permission // 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} // // This member is required. AccessPolicyArn *string // The AWS IoT SiteWise Monitor resource (portal or project) to which this access // policy provides access. // // This member is required. AccessPolicyResource *types.Resource // The ID of the access policy. // // This member is required. AccessPolicyId *string // The AWS SSO identity (user or group) to which this access policy applies. // // This member is required. AccessPolicyIdentity *types.Identity // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeAssetInput ¶
type DescribeAssetInput struct { // The ID of the asset. // // This member is required. AssetId *string }
type DescribeAssetModelInput ¶
type DescribeAssetModelInput struct { // The ID of the asset model. // // This member is required. AssetModelId *string }
type DescribeAssetModelOutput ¶
type DescribeAssetModelOutput struct { // 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. // // This member is required. AssetModelHierarchies []*types.AssetModelHierarchy // The ID of the asset model. // // This member is required. AssetModelId *string // The name of the asset model. // // This member is required. AssetModelName *string // The date the asset model was last updated, in Unix epoch time. // // This member is required. AssetModelLastUpdateDate *time.Time // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the asset model, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId} // // This member is required. AssetModelArn *string // The list of asset properties for the asset model. // // This member is required. AssetModelProperties []*types.AssetModelProperty // The asset model's description. // // This member is required. AssetModelDescription *string // The current status of the asset model, which contains a state and any error // message. // // This member is required. AssetModelStatus *types.AssetModelStatus // The date the asset model was created, in Unix epoch time. // // This member is required. AssetModelCreationDate *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeAssetOutput ¶
type DescribeAssetOutput struct { // A list of asset hierarchies that each contain a hierarchyId. A hierarchy // specifies allowed parent/child asset relationships. // // This member is required. AssetHierarchies []*types.AssetHierarchy // The date the asset was last updated, in Unix epoch time. // // This member is required. AssetLastUpdateDate *time.Time // The date the asset was created, in Unix epoch time. // // This member is required. AssetCreationDate *time.Time // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the asset, which has the following format. // arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} // // This member is required. AssetArn *string // The name of the asset. // // This member is required. AssetName *string // The ID of the asset model that was used to create the asset. // // This member is required. AssetModelId *string // The current status of the asset, which contains a state and any error message. // // This member is required. AssetStatus *types.AssetStatus // The list of asset properties for the asset. // // This member is required. AssetProperties []*types.AssetProperty // The ID of the asset. // // This member is required. AssetId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeAssetPropertyInput ¶
type DescribeAssetPropertyInput struct { // The ID of the asset property. // // This member is required. PropertyId *string // The ID of the asset. // // This member is required. AssetId *string }
type DescribeAssetPropertyOutput ¶
type DescribeAssetPropertyOutput struct { // The ID of the asset. // // This member is required. AssetId *string // The ID of the asset model. // // This member is required. AssetModelId *string // The asset property's definition, alias, and notification state. // // This member is required. AssetProperty *types.Property // The name of the asset. // // This member is required. AssetName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeDashboardInput ¶
type DescribeDashboardInput struct { // The ID of the dashboard. // // This member is required. DashboardId *string }
type DescribeDashboardOutput ¶
type DescribeDashboardOutput struct { // The ID of the project that the dashboard is in. // // This member is required. ProjectId *string // The date the dashboard was created, in Unix epoch time. // // This member is required. DashboardCreationDate *time.Time // The ID of the dashboard. // // This member is required. DashboardId *string // The dashboard's description. DashboardDescription *string // The date the dashboard was last updated, in Unix epoch time. // // This member is required. DashboardLastUpdateDate *time.Time // 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. // // This member is required. DashboardDefinition *string // 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} // // This member is required. DashboardArn *string // The name of the dashboard. // // This member is required. DashboardName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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. // // This member is required. CapabilityNamespace *string // The ID of the gateway that defines the capability configuration. // // This member is required. GatewayId *string }
type DescribeGatewayCapabilityConfigurationOutput ¶
type DescribeGatewayCapabilityConfigurationOutput struct { // The namespace of the gateway capability. // // This member is required. CapabilityNamespace *string // 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. // // This member is required. CapabilityConfiguration *string // The synchronization status of the capability configuration. The sync status can // be one of the following: // // * IN_SYNC – The gateway is running the capability // configuration. // // * OUT_OF_SYNC – The gateway hasn't received the capability // configuration. // // * SYNC_FAILED – The gateway rejected the capability // configuration. // // This member is required. CapabilitySyncStatus types.CapabilitySyncStatus // The ID of the gateway that defines the capability configuration. // // This member is required. GatewayId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeGatewayInput ¶
type DescribeGatewayInput struct { // The ID of the gateway device. // // This member is required. GatewayId *string }
type DescribeGatewayOutput ¶
type DescribeGatewayOutput struct { // The name of the gateway. // // This member is required. GatewayName *string // 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} // // This member is required. GatewayArn *string // The ID of the gateway device. // // This member is required. GatewayId *string // The date the gateway was last updated, in Unix epoch time. // // This member is required. LastUpdateDate *time.Time // The gateway's platform. GatewayPlatform *types.GatewayPlatform // The date the gateway was created, in Unix epoch time. // // This member is required. CreationDate *time.Time // A list of gateway capability summaries that each contain a namespace and status. // Each gateway capability defines data sources for the gateway. To retrieve a // capability configuration's definition, use // DescribeGatewayCapabilityConfiguration // (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html). // // This member is required. GatewayCapabilitySummaries []*types.GatewayCapabilitySummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeLoggingOptionsInput ¶
type DescribeLoggingOptionsInput struct { }
type DescribeLoggingOptionsOutput ¶
type DescribeLoggingOptionsOutput struct { // The current logging options. // // This member is required. LoggingOptions *types.LoggingOptions // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribePortalInput ¶
type DescribePortalInput struct { // The ID of the portal. // // This member is required. PortalId *string }
type DescribePortalOutput ¶
type DescribePortalOutput struct { // The date the portal was created, in Unix epoch time. // // This member is required. PortalCreationDate *time.Time // The date the portal was last updated, in Unix epoch time. // // This member is required. PortalLastUpdateDate *time.Time // 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} // // This member is required. PortalArn *string // The portal's logo image, which is available at a URL. PortalLogoImageLocation *types.ImageLocation // The AWS SSO application generated client ID (used with AWS SSO APIs). // // This member is required. PortalClientId *string // The AWS administrator's contact email address. // // This member is required. PortalContactEmail *string // The ID of the portal. // // This member is required. PortalId *string // The public root URL for the AWS IoT AWS IoT SiteWise Monitor application portal. // // This member is required. PortalStartUrl *string // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the service role that allows the portal's users to access your AWS IoT SiteWise // resources on your behalf. For more information, see Using service roles for AWS // IoT SiteWise Monitor // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html) // in the AWS IoT SiteWise User Guide. RoleArn *string // The name of the portal. // // This member is required. PortalName *string // The current status of the portal, which contains a state and any error message. // // This member is required. PortalStatus *types.PortalStatus // The portal's description. PortalDescription *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeProjectInput ¶
type DescribeProjectInput struct { // The ID of the project. // // This member is required. ProjectId *string }
type DescribeProjectOutput ¶
type DescribeProjectOutput struct { // The date the project was last updated, in Unix epoch time. // // This member is required. ProjectLastUpdateDate *time.Time // The ID of the portal that the project is in. // // This member is required. PortalId *string // The project's description. ProjectDescription *string // The date the project was created, in Unix epoch time. // // This member is required. ProjectCreationDate *time.Time // The name of the project. // // This member is required. ProjectName *string // The ID of the project. // // This member is required. ProjectId *string // 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} // // This member is required. ProjectArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DisassociateAssetsInput ¶
type DisassociateAssetsInput 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 // 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. // // This member is required. HierarchyId *string // The ID of the parent asset from which to disassociate the child asset. // // This member is required. AssetId *string // The ID of the child asset to disassociate. // // This member is required. ChildAssetId *string }
type DisassociateAssetsOutput ¶
type DisassociateAssetsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)
type GetAssetPropertyAggregatesInput ¶
type GetAssetPropertyAggregatesInput struct { // The ID of the asset property. PropertyId *string // The exclusive start of the range from which to query historical data, expressed // in seconds in Unix epoch time. // // This member is required. StartDate *time.Time // The maximum number of results to be returned per paginated request. MaxResults *int32 // The inclusive end of the range from which to query historical data, expressed in // seconds in Unix epoch time. // // This member is required. EndDate *time.Time // The data aggregating function. // // This member is required. AggregateTypes []types.AggregateType // The ID of the asset. AssetId *string // The property alias that identifies the property, such as an OPC-UA server data // stream path (for example, /company/windfarm/3/turbine/7/temperature). For more // information, see Mapping Industrial Data Streams to Asset Properties // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the AWS IoT SiteWise User Guide. PropertyAlias *string // The time interval over which to aggregate data. // // This member is required. Resolution *string // The token to be used for the next set of paginated results. NextToken *string // The chronological sorting order of the requested information. TimeOrdering types.TimeOrdering // The quality by which to filter asset data. Qualities []types.Quality }
type GetAssetPropertyAggregatesOutput ¶
type GetAssetPropertyAggregatesOutput struct { // The requested aggregated values. // // This member is required. AggregatedValues []*types.AggregatedValue // The token for the next set of results, or null if there are no additional // results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetAssetPropertyValueHistoryInput ¶
type GetAssetPropertyValueHistoryInput struct { // The quality by which to filter asset data. Qualities []types.Quality // The chronological sorting order of the requested information. TimeOrdering types.TimeOrdering // The property alias that identifies the property, such as an OPC-UA server data // stream path (for example, /company/windfarm/3/turbine/7/temperature). For more // information, see Mapping Industrial Data Streams to Asset Properties // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the AWS IoT SiteWise User Guide. PropertyAlias *string // The ID of the asset property. PropertyId *string // The exclusive start of the range from which to query historical data, expressed // in seconds in Unix epoch time. StartDate *time.Time // The maximum number of results to be returned per paginated request. MaxResults *int32 // The ID of the asset. AssetId *string // The inclusive end of the range from which to query historical data, expressed in // seconds in Unix epoch time. EndDate *time.Time // The token to be used for the next set of paginated results. NextToken *string }
type GetAssetPropertyValueHistoryOutput ¶
type GetAssetPropertyValueHistoryOutput struct { // The asset property's value history. // // This member is required. AssetPropertyValueHistory []*types.AssetPropertyValue // The token for the next set of results, or null if there are no additional // results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetAssetPropertyValueInput ¶
type GetAssetPropertyValueInput struct { // The ID of the asset. AssetId *string // The property alias that identifies the property, such as an OPC-UA server data // stream path (for example, /company/windfarm/3/turbine/7/temperature). For more // information, see Mapping Industrial Data Streams to Asset Properties // (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) // in the AWS IoT SiteWise User Guide. PropertyAlias *string // The ID of the asset property. PropertyId *string }
type GetAssetPropertyValueOutput ¶
type GetAssetPropertyValueOutput struct { // The current asset property value. PropertyValue *types.AssetPropertyValue // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error }
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ListAccessPoliciesInput ¶
type ListAccessPoliciesInput struct { // The ID of the identity. This parameter is required if you specify identityType. IdentityId *string // The type of identity (user or group). This parameter is required if you specify // identityId. IdentityType types.IdentityType // The token to be used for the next set of paginated results. NextToken *string // The ID of the resource. This parameter is required if you specify resourceType. ResourceId *string // The type of resource (portal or project). This parameter is required if you // specify resourceId. ResourceType types.ResourceType // The maximum number of results to be returned per paginated request. MaxResults *int32 }
type ListAccessPoliciesOutput ¶
type ListAccessPoliciesOutput struct { // The token for the next set of results, or null if there are no additional // results. NextToken *string // A list that summarizes each access policy. // // This member is required. AccessPolicySummaries []*types.AccessPolicySummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListAssetModelsInput ¶
type ListAssetModelsInput struct { // The token to be used for the next set of paginated results. NextToken *string // The maximum number of results to be returned per paginated request. MaxResults *int32 }
type ListAssetModelsOutput ¶
type ListAssetModelsOutput struct { // A list that summarizes each asset model. // // This member is required. AssetModelSummaries []*types.AssetModelSummary // The token for the next set of results, or null if there are no additional // results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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 // 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 types.ListAssetsFilter // The token to be used for the next set of paginated results. NextToken *string // The maximum number of results to be returned per paginated request. MaxResults *int32 }
type ListAssetsOutput ¶
type ListAssetsOutput struct { // A list that summarizes each asset. // // This member is required. AssetSummaries []*types.AssetSummary // The token for the next set of results, or null if there are no additional // results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListAssociatedAssetsInput ¶
type ListAssociatedAssetsInput struct { // The ID of the parent asset. // // This member is required. AssetId *string // The maximum number of results to be returned per paginated request. MaxResults *int32 // 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. // // This member is required. HierarchyId *string // The token to be used for the next set of paginated results. NextToken *string }
type ListAssociatedAssetsOutput ¶
type ListAssociatedAssetsOutput struct { // The token for the next set of results, or null if there are no additional // results. NextToken *string // A list that summarizes the associated assets. // // This member is required. AssetSummaries []*types.AssociatedAssetsSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListDashboardsInput ¶
type ListDashboardsInput struct { // The ID of the project. // // This member is required. ProjectId *string // The maximum number of results to be returned per paginated request. MaxResults *int32 // The token to be used for the next set of paginated results. NextToken *string }
type ListDashboardsOutput ¶
type ListDashboardsOutput struct { // The token for the next set of results, or null if there are no additional // results. NextToken *string // A list that summarizes each dashboard in the project. // // This member is required. DashboardSummaries []*types.DashboardSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListGatewaysInput ¶
type ListGatewaysInput struct { // The token to be used for the next set of paginated results. NextToken *string // The maximum number of results to be returned per paginated request. MaxResults *int32 }
type ListGatewaysOutput ¶
type ListGatewaysOutput struct { // A list that summarizes each gateway. // // This member is required. GatewaySummaries []*types.GatewaySummary // The token for the next set of results, or null if there are no additional // results. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListPortalsInput ¶
type ListPortalsInput struct { // The maximum number of results to be returned per paginated request. MaxResults *int32 // The token to be used for the next set of paginated results. NextToken *string }
type ListPortalsOutput ¶
type ListPortalsOutput struct { // The token for the next set of results, or null if there are no additional // results. NextToken *string // A list that summarizes each portal. PortalSummaries []*types.PortalSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListProjectAssetsInput ¶
type ListProjectAssetsInput struct { // The maximum number of results to be returned per paginated request. MaxResults *int32 // The ID of the project. // // This member is required. ProjectId *string // The token to be used for the next set of paginated results. NextToken *string }
type ListProjectAssetsOutput ¶
type ListProjectAssetsOutput struct { // The token for the next set of results, or null if there are no additional // results. NextToken *string // A list that contains the IDs of each asset associated with the project. // // This member is required. AssetIds []*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListProjectsInput ¶
type ListProjectsInput struct { // The ID of the portal. // // This member is required. PortalId *string // The token to be used for the next set of paginated results. NextToken *string // The maximum number of results to be returned per paginated request. MaxResults *int32 }
type ListProjectsOutput ¶
type ListProjectsOutput struct { // The token for the next set of results, or null if there are no additional // results. NextToken *string // A list that summarizes each project in the portal. // // This member is required. ProjectSummaries []*types.ProjectSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the resource. // // This member is required. ResourceArn *string }
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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions ResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // Provides idempotency tokens values that will be automatically populated into // idempotent API operations. IdempotencyTokenProvider IdempotencyTokenProvider // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
func (Options) GetCredentials ¶
func (o Options) GetCredentials() aws.CredentialsProvider
func (Options) GetEndpointOptions ¶
func (o Options) GetEndpointOptions() ResolverOptions
func (Options) GetEndpointResolver ¶
func (o Options) GetEndpointResolver() EndpointResolver
func (Options) GetHTTPSignerV4 ¶
func (o Options) GetHTTPSignerV4() HTTPSignerV4
func (Options) GetIdempotencyTokenProvider ¶
func (o Options) GetIdempotencyTokenProvider() IdempotencyTokenProvider
func (Options) GetRegion ¶
func (Options) GetRetryer ¶
type PutLoggingOptionsInput ¶
type PutLoggingOptionsInput struct { // The logging options to set. // // This member is required. LoggingOptions *types.LoggingOptions }
type PutLoggingOptionsOutput ¶
type PutLoggingOptionsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options ResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type ResolveEndpointMiddlewareOptions ¶
type ResolveEndpointMiddlewareOptions interface { GetEndpointResolver() EndpointResolver GetEndpointOptions() ResolverOptions }
type ResolverOptions ¶
type ResolverOptions = internalendpoints.Options
ResolverOptions is the service endpoint resolver options
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. // // This member is required. ResourceArn *string // 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. // // This member is required. Tags map[string]*string }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UntagResourceInput ¶
type UntagResourceInput struct { // A list of keys for tags to remove from the resource. // // This member is required. TagKeys []*string // The ARN // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of // the resource to untag. // // This member is required. ResourceArn *string }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateAccessPolicyInput ¶
type UpdateAccessPolicyInput struct { // The permission level for this access policy. Note that a project ADMINISTRATOR // is also known as a project owner. // // This member is required. AccessPolicyPermission types.Permission // 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 // The ID of the access policy. // // This member is required. AccessPolicyId *string // The AWS IoT SiteWise Monitor resource for this access policy. Choose either // portal or project but not both. // // This member is required. AccessPolicyResource *types.Resource // The identity for this access policy. Choose either a user or a group but not // both. // // This member is required. AccessPolicyIdentity *types.Identity }
type UpdateAccessPolicyOutput ¶
type UpdateAccessPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateAssetInput ¶
type UpdateAssetInput struct { // A unique, friendly name for the asset. // // This member is required. AssetName *string // The ID of the asset to update. // // This member is required. AssetId *string // A unique case-sensitive identifier that you can provide to ensure the // idempotency of the request. Don't reuse this client token if a new idempotent // request is required. ClientToken *string }
type UpdateAssetModelInput ¶
type UpdateAssetModelInput struct { // The ID of the asset model to update. // // This member is required. AssetModelId *string // A unique, friendly name for the asset model. // // This member is required. AssetModelName *string // A unique case-sensitive identifier that you can provide to ensure the // idempotency of the request. Don't reuse this client token if a new idempotent // request is required. ClientToken *string // A description for the asset model. AssetModelDescription *string // 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 []*types.AssetModelProperty // 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 []*types.AssetModelHierarchy }
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. // // This member is required. AssetModelStatus *types.AssetModelStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateAssetOutput ¶
type UpdateAssetOutput struct { // The status of the asset, which contains a state (UPDATING after successfully // calling this operation) and any error message. // // This member is required. AssetStatus *types.AssetStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateAssetPropertyInput ¶
type UpdateAssetPropertyInput 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 // 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 // The ID of the asset property to be updated. // // This member is required. PropertyId *string // The ID of the asset to be updated. // // This member is required. AssetId *string // 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 types.PropertyNotificationState }
type UpdateAssetPropertyOutput ¶
type UpdateAssetPropertyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateDashboardInput ¶
type UpdateDashboardInput struct { // A new friendly name for the dashboard. // // This member is required. DashboardName *string // The ID of the dashboard to update. // // This member is required. DashboardId *string // A new description for the dashboard. DashboardDescription *string // 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. // // This member is required. DashboardDefinition *string // A unique case-sensitive identifier that you can provide to ensure the // idempotency of the request. Don't reuse this client token if a new idempotent // request is required. ClientToken *string }
type UpdateDashboardOutput ¶
type UpdateDashboardOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateGatewayCapabilityConfigurationInput ¶
type UpdateGatewayCapabilityConfigurationInput struct { // 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. // // This member is required. CapabilityNamespace *string // 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. // // This member is required. CapabilityConfiguration *string // The ID of the gateway to be updated. // // This member is required. GatewayId *string }
type UpdateGatewayCapabilityConfigurationOutput ¶
type UpdateGatewayCapabilityConfigurationOutput struct { // 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. // // This member is required. CapabilitySyncStatus types.CapabilitySyncStatus // The namespace of the gateway capability. // // This member is required. CapabilityNamespace *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateGatewayInput ¶
type UpdateGatewayInput struct { // A unique, friendly name for the gateway. // // This member is required. GatewayName *string // The ID of the gateway to update. // // This member is required. GatewayId *string }
type UpdateGatewayOutput ¶
type UpdateGatewayOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdatePortalInput ¶
type UpdatePortalInput struct { // A new friendly name for the portal. // // This member is required. PortalName *string // A new description for the portal. PortalDescription *string // Contains an image that is one of the following: // // * An image file. Choose // this option to upload a new image. // // * The ID of an existing image. Choose // this option to keep an existing image. PortalLogoImage *types.Image // 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 // The ID of the portal to update. // // This member is required. PortalId *string // The AWS administrator's contact email address. // // This member is required. PortalContactEmail *string // 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. // // This member is required. RoleArn *string }
type UpdatePortalOutput ¶
type UpdatePortalOutput struct { // The status of the portal, which contains a state (UPDATING after successfully // calling this operation) and any error message. // // This member is required. PortalStatus *types.PortalStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateProjectInput ¶
type UpdateProjectInput struct { // A new description for the project. ProjectDescription *string // A new friendly name for the project. // // This member is required. ProjectName *string // The ID of the project to update. // // This member is required. ProjectId *string // A unique case-sensitive identifier that you can provide to ensure the // idempotency of the request. Don't reuse this client token if a new idempotent // request is required. ClientToken *string }
type UpdateProjectOutput ¶
type UpdateProjectOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
api_client.go api_op_AssociateAssets.go api_op_BatchAssociateProjectAssets.go api_op_BatchDisassociateProjectAssets.go api_op_BatchPutAssetPropertyValue.go api_op_CreateAccessPolicy.go api_op_CreateAsset.go api_op_CreateAssetModel.go api_op_CreateDashboard.go api_op_CreateGateway.go api_op_CreatePortal.go api_op_CreateProject.go api_op_DeleteAccessPolicy.go api_op_DeleteAsset.go api_op_DeleteAssetModel.go api_op_DeleteDashboard.go api_op_DeleteGateway.go api_op_DeletePortal.go api_op_DeleteProject.go api_op_DescribeAccessPolicy.go api_op_DescribeAsset.go api_op_DescribeAssetModel.go api_op_DescribeAssetProperty.go api_op_DescribeDashboard.go api_op_DescribeGateway.go api_op_DescribeGatewayCapabilityConfiguration.go api_op_DescribeLoggingOptions.go api_op_DescribePortal.go api_op_DescribeProject.go api_op_DisassociateAssets.go api_op_GetAssetPropertyAggregates.go api_op_GetAssetPropertyValue.go api_op_GetAssetPropertyValueHistory.go api_op_ListAccessPolicies.go api_op_ListAssetModels.go api_op_ListAssets.go api_op_ListAssociatedAssets.go api_op_ListDashboards.go api_op_ListGateways.go api_op_ListPortals.go api_op_ListProjectAssets.go api_op_ListProjects.go api_op_ListTagsForResource.go api_op_PutLoggingOptions.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateAccessPolicy.go api_op_UpdateAsset.go api_op_UpdateAssetModel.go api_op_UpdateAssetProperty.go api_op_UpdateDashboard.go api_op_UpdateGateway.go api_op_UpdateGatewayCapabilityConfiguration.go api_op_UpdatePortal.go api_op_UpdateProject.go deserializers.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.26.0
- Published
- Oct 1, 2020
- Platform
- js/wasm
- Imports
- 28 packages
- Last checked
- 6 days ago –
Tools for package owners.