iotsitewise

package module
v1.42.3 Latest Latest
Warning

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

 Go to latest Published: Sep 27, 2024 License: Apache-2.0 Imports: 48 Imported by: 10

Documentation

Overview

Package iotsitewise provides the API client, operations, and parameter types for AWS IoT SiteWise.

Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects Industrial Internet of Things (IIoT)devices to the power of the Amazon Web Services Cloud. For more information, see the IoT SiteWise User Guide. For information about IoT SiteWise quotas, see Quotasin the IoT SiteWise User Guide.

Index

Constants

View Source 
const ServiceAPIVersion = "2019-12-02"
View Source 
const ServiceID = "IoTSiteWise"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.30.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.32.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.32.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AssetActiveWaiter added in v0.31.0 

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

AssetActiveWaiter defines the waiters for AssetActive

func NewAssetActiveWaiter added in v0.31.0 

func NewAssetActiveWaiter(client DescribeAssetAPIClient, optFns ...func(*AssetActiveWaiterOptions)) *AssetActiveWaiter

NewAssetActiveWaiter constructs a AssetActiveWaiter.

func (*AssetActiveWaiter) Wait added in v0.31.0 

func (w *AssetActiveWaiter) Wait(ctx context.Context, params *DescribeAssetInput, maxWaitDur time.Duration, optFns ...func(*AssetActiveWaiterOptions)) error

Wait calls the waiter function for AssetActive waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*AssetActiveWaiter) WaitForOutput added in v1.14.0 

func (w *AssetActiveWaiter) WaitForOutput(ctx context.Context, params *DescribeAssetInput, maxWaitDur time.Duration, optFns ...func(*AssetActiveWaiterOptions)) (*DescribeAssetOutput, error)

WaitForOutput calls the waiter function for AssetActive waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type AssetActiveWaiterOptions added in v0.31.0 

type AssetActiveWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// AssetActiveWaiter will use default minimum delay of 3 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, AssetActiveWaiter will use default max delay of 120 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeAssetInput, *DescribeAssetOutput, error) (bool, error)
}

AssetActiveWaiterOptions are waiter options for AssetActiveWaiter

type AssetModelActiveWaiter added in v0.31.0 

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

AssetModelActiveWaiter defines the waiters for AssetModelActive

func NewAssetModelActiveWaiter added in v0.31.0 

func NewAssetModelActiveWaiter(client DescribeAssetModelAPIClient, optFns ...func(*AssetModelActiveWaiterOptions)) *AssetModelActiveWaiter

NewAssetModelActiveWaiter constructs a AssetModelActiveWaiter.

func (*AssetModelActiveWaiter) Wait added in v0.31.0 

func (w *AssetModelActiveWaiter) Wait(ctx context.Context, params *DescribeAssetModelInput, maxWaitDur time.Duration, optFns ...func(*AssetModelActiveWaiterOptions)) error

Wait calls the waiter function for AssetModelActive waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*AssetModelActiveWaiter) WaitForOutput added in v1.14.0 

func (w *AssetModelActiveWaiter) WaitForOutput(ctx context.Context, params *DescribeAssetModelInput, maxWaitDur time.Duration, optFns ...func(*AssetModelActiveWaiterOptions)) (*DescribeAssetModelOutput, error)

WaitForOutput calls the waiter function for AssetModelActive waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type AssetModelActiveWaiterOptions added in v0.31.0 

type AssetModelActiveWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// AssetModelActiveWaiter will use default minimum delay of 3 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, AssetModelActiveWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeAssetModelInput, *DescribeAssetModelOutput, error) (bool, error)
}

AssetModelActiveWaiterOptions are waiter options for AssetModelActiveWaiter

type AssetModelNotExistsWaiter added in v0.31.0 

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

AssetModelNotExistsWaiter defines the waiters for AssetModelNotExists

func NewAssetModelNotExistsWaiter added in v0.31.0 

func NewAssetModelNotExistsWaiter(client DescribeAssetModelAPIClient, optFns ...func(*AssetModelNotExistsWaiterOptions)) *AssetModelNotExistsWaiter

NewAssetModelNotExistsWaiter constructs a AssetModelNotExistsWaiter.

func (*AssetModelNotExistsWaiter) Wait added in v0.31.0 

func (w *AssetModelNotExistsWaiter) Wait(ctx context.Context, params *DescribeAssetModelInput, maxWaitDur time.Duration, optFns ...func(*AssetModelNotExistsWaiterOptions)) error

Wait calls the waiter function for AssetModelNotExists waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*AssetModelNotExistsWaiter) WaitForOutput added in v1.14.0 

func (w *AssetModelNotExistsWaiter) WaitForOutput(ctx context.Context, params *DescribeAssetModelInput, maxWaitDur time.Duration, optFns ...func(*AssetModelNotExistsWaiterOptions)) (*DescribeAssetModelOutput, error)

WaitForOutput calls the waiter function for AssetModelNotExists waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type AssetModelNotExistsWaiterOptions added in v0.31.0 

type AssetModelNotExistsWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// AssetModelNotExistsWaiter will use default minimum delay of 3 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, AssetModelNotExistsWaiter will use default max delay of 120
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeAssetModelInput, *DescribeAssetModelOutput, error) (bool, error)
}

AssetModelNotExistsWaiterOptions are waiter options for AssetModelNotExistsWaiter

type AssetNotExistsWaiter added in v0.31.0 

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

AssetNotExistsWaiter defines the waiters for AssetNotExists

func NewAssetNotExistsWaiter added in v0.31.0 

func NewAssetNotExistsWaiter(client DescribeAssetAPIClient, optFns ...func(*AssetNotExistsWaiterOptions)) *AssetNotExistsWaiter

NewAssetNotExistsWaiter constructs a AssetNotExistsWaiter.

func (*AssetNotExistsWaiter) Wait added in v0.31.0 

func (w *AssetNotExistsWaiter) Wait(ctx context.Context, params *DescribeAssetInput, maxWaitDur time.Duration, optFns ...func(*AssetNotExistsWaiterOptions)) error

Wait calls the waiter function for AssetNotExists waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*AssetNotExistsWaiter) WaitForOutput added in v1.14.0 

func (w *AssetNotExistsWaiter) WaitForOutput(ctx context.Context, params *DescribeAssetInput, maxWaitDur time.Duration, optFns ...func(*AssetNotExistsWaiterOptions)) (*DescribeAssetOutput, error)

WaitForOutput calls the waiter function for AssetNotExists waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type AssetNotExistsWaiterOptions added in v0.31.0 

type AssetNotExistsWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// AssetNotExistsWaiter will use default minimum delay of 3 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, AssetNotExistsWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeAssetInput, *DescribeAssetOutput, error) (bool, error)
}

AssetNotExistsWaiterOptions are waiter options for AssetNotExistsWaiter

type AssociateAssetsInput 

type AssociateAssetsInput struct {

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

	// The ID of the child asset to be associated. This can be either the actual ID in
	// UUID format, or else externalId: followed by the external ID, if it has one.
	// For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.
	//
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	//
	// This member is required.
	ChildAssetId *string

	// The ID of a hierarchy in the parent asset's model. (This can be either the
	// actual ID in UUID format, or else externalId: followed by the external ID, if
	// it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.)
	// Hierarchies allow different groupings of assets to be formed that all come from
	// the same asset model. For more information, see [Asset hierarchies]in the IoT SiteWise User Guide.
	//
	// [Asset hierarchies]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	//
	// 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
	// contains filtered or unexported fields
}

type AssociateAssetsOutput 

type AssociateAssetsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssociateTimeSeriesToAssetPropertyInput added in v1.15.0 

type AssociateTimeSeriesToAssetPropertyInput struct {

	// The alias that identifies the time series.
	//
	// This member is required.
	Alias *string

	// The ID of the asset in which the asset property was created. This can be either
	// the actual ID in UUID format, or else externalId: followed by the external ID,
	// if it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.
	//
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	//
	// This member is required.
	AssetId *string

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

type AssociateTimeSeriesToAssetPropertyOutput added in v1.15.0 

type AssociateTimeSeriesToAssetPropertyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters added in v1.32.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.32.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

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

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

type BatchDisassociateProjectAssetsInput 

type BatchDisassociateProjectAssetsInput struct {

	// The IDs of the assets to be disassociated from the project.
	//
	// This member is required.
	AssetIds []string

	// The ID of the project from which to disassociate 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
	// contains filtered or unexported fields
}

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

type BatchGetAssetPropertyAggregatesAPIClient added in v1.21.0 

type BatchGetAssetPropertyAggregatesAPIClient interface {
	BatchGetAssetPropertyAggregates(context.Context, *BatchGetAssetPropertyAggregatesInput, ...func(*Options)) (*BatchGetAssetPropertyAggregatesOutput, error)
}

BatchGetAssetPropertyAggregatesAPIClient is a client that implements the BatchGetAssetPropertyAggregates operation.

type BatchGetAssetPropertyAggregatesInput added in v1.21.0 

type BatchGetAssetPropertyAggregatesInput struct {

	// The list of asset property aggregate entries for the batch get request. You can
	// specify up to 16 entries per request.
	//
	// This member is required.
	Entries []types.BatchGetAssetPropertyAggregatesEntry

	// The maximum number of results to return for each paginated request. A result
	// set is returned in the two cases, whichever occurs first.
	//
	//   - The size of the result set is equal to 1 MB.
	//
	//   - The number of data points in the result set is equal to the value of
	//   maxResults . The maximum value of maxResults is 4000.
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

type BatchGetAssetPropertyAggregatesOutput added in v1.21.0 

type BatchGetAssetPropertyAggregatesOutput struct {

	// A list of the errors (if any) associated with the batch request. Each error
	// entry contains the entryId of the entry that failed.
	//
	// This member is required.
	ErrorEntries []types.BatchGetAssetPropertyAggregatesErrorEntry

	// A list of entries that were not processed by this batch request. because these
	// entries had been completely processed by previous paginated requests. Each
	// skipped entry contains the entryId of the entry that skipped.
	//
	// This member is required.
	SkippedEntries []types.BatchGetAssetPropertyAggregatesSkippedEntry

	// A list of entries that were processed successfully by this batch request. Each
	// success entry contains the entryId of the entry that succeeded and the latest
	// query result.
	//
	// This member is required.
	SuccessEntries []types.BatchGetAssetPropertyAggregatesSuccessEntry

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

type BatchGetAssetPropertyAggregatesPaginator added in v1.21.0 

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

BatchGetAssetPropertyAggregatesPaginator is a paginator for BatchGetAssetPropertyAggregates

func NewBatchGetAssetPropertyAggregatesPaginator added in v1.21.0 

func NewBatchGetAssetPropertyAggregatesPaginator(client BatchGetAssetPropertyAggregatesAPIClient, params *BatchGetAssetPropertyAggregatesInput, optFns ...func(*BatchGetAssetPropertyAggregatesPaginatorOptions)) *BatchGetAssetPropertyAggregatesPaginator

NewBatchGetAssetPropertyAggregatesPaginator returns a new BatchGetAssetPropertyAggregatesPaginator

func (*BatchGetAssetPropertyAggregatesPaginator) HasMorePages added in v1.21.0 

func (p *BatchGetAssetPropertyAggregatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*BatchGetAssetPropertyAggregatesPaginator) NextPage added in v1.21.0 

func (p *BatchGetAssetPropertyAggregatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*BatchGetAssetPropertyAggregatesOutput, error)

NextPage retrieves the next BatchGetAssetPropertyAggregates page.

type BatchGetAssetPropertyAggregatesPaginatorOptions added in v1.21.0 

type BatchGetAssetPropertyAggregatesPaginatorOptions struct {
	// The maximum number of results to return for each paginated request. A result
	// set is returned in the two cases, whichever occurs first.
	//
	//   - The size of the result set is equal to 1 MB.
	//
	//   - The number of data points in the result set is equal to the value of
	//   maxResults . The maximum value of maxResults is 4000.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

BatchGetAssetPropertyAggregatesPaginatorOptions is the paginator options for BatchGetAssetPropertyAggregates

type BatchGetAssetPropertyValueAPIClient added in v1.21.0 

type BatchGetAssetPropertyValueAPIClient interface {
	BatchGetAssetPropertyValue(context.Context, *BatchGetAssetPropertyValueInput, ...func(*Options)) (*BatchGetAssetPropertyValueOutput, error)
}

BatchGetAssetPropertyValueAPIClient is a client that implements the BatchGetAssetPropertyValue operation.

type BatchGetAssetPropertyValueHistoryAPIClient added in v1.21.0 

type BatchGetAssetPropertyValueHistoryAPIClient interface {
	BatchGetAssetPropertyValueHistory(context.Context, *BatchGetAssetPropertyValueHistoryInput, ...func(*Options)) (*BatchGetAssetPropertyValueHistoryOutput, error)
}

BatchGetAssetPropertyValueHistoryAPIClient is a client that implements the BatchGetAssetPropertyValueHistory operation.

type BatchGetAssetPropertyValueHistoryInput added in v1.21.0 

type BatchGetAssetPropertyValueHistoryInput struct {

	// The list of asset property historical value entries for the batch get request.
	// You can specify up to 16 entries per request.
	//
	// This member is required.
	Entries []types.BatchGetAssetPropertyValueHistoryEntry

	// The maximum number of results to return for each paginated request. A result
	// set is returned in the two cases, whichever occurs first.
	//
	//   - The size of the result set is equal to 4 MB.
	//
	//   - The number of data points in the result set is equal to the value of
	//   maxResults . The maximum value of maxResults is 20000.
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

type BatchGetAssetPropertyValueHistoryOutput added in v1.21.0 

type BatchGetAssetPropertyValueHistoryOutput struct {

	// A list of the errors (if any) associated with the batch request. Each error
	// entry contains the entryId of the entry that failed.
	//
	// This member is required.
	ErrorEntries []types.BatchGetAssetPropertyValueHistoryErrorEntry

	// A list of entries that were not processed by this batch request. because these
	// entries had been completely processed by previous paginated requests. Each
	// skipped entry contains the entryId of the entry that skipped.
	//
	// This member is required.
	SkippedEntries []types.BatchGetAssetPropertyValueHistorySkippedEntry

	// A list of entries that were processed successfully by this batch request. Each
	// success entry contains the entryId of the entry that succeeded and the latest
	// query result.
	//
	// This member is required.
	SuccessEntries []types.BatchGetAssetPropertyValueHistorySuccessEntry

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

type BatchGetAssetPropertyValueHistoryPaginator added in v1.21.0 

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

BatchGetAssetPropertyValueHistoryPaginator is a paginator for BatchGetAssetPropertyValueHistory

func NewBatchGetAssetPropertyValueHistoryPaginator added in v1.21.0 

func NewBatchGetAssetPropertyValueHistoryPaginator(client BatchGetAssetPropertyValueHistoryAPIClient, params *BatchGetAssetPropertyValueHistoryInput, optFns ...func(*BatchGetAssetPropertyValueHistoryPaginatorOptions)) *BatchGetAssetPropertyValueHistoryPaginator

NewBatchGetAssetPropertyValueHistoryPaginator returns a new BatchGetAssetPropertyValueHistoryPaginator

func (*BatchGetAssetPropertyValueHistoryPaginator) HasMorePages added in v1.21.0 

func (p *BatchGetAssetPropertyValueHistoryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*BatchGetAssetPropertyValueHistoryPaginator) NextPage added in v1.21.0 

func (p *BatchGetAssetPropertyValueHistoryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*BatchGetAssetPropertyValueHistoryOutput, error)

NextPage retrieves the next BatchGetAssetPropertyValueHistory page.

type BatchGetAssetPropertyValueHistoryPaginatorOptions added in v1.21.0 

type BatchGetAssetPropertyValueHistoryPaginatorOptions struct {
	// The maximum number of results to return for each paginated request. A result
	// set is returned in the two cases, whichever occurs first.
	//
	//   - The size of the result set is equal to 4 MB.
	//
	//   - The number of data points in the result set is equal to the value of
	//   maxResults . The maximum value of maxResults is 20000.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

BatchGetAssetPropertyValueHistoryPaginatorOptions is the paginator options for BatchGetAssetPropertyValueHistory

type BatchGetAssetPropertyValueInput added in v1.21.0 

type BatchGetAssetPropertyValueInput struct {

	// The list of asset property value entries for the batch get request. You can
	// specify up to 128 entries per request.
	//
	// This member is required.
	Entries []types.BatchGetAssetPropertyValueEntry

	// The token to be used for the next set of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

type BatchGetAssetPropertyValueOutput added in v1.21.0 

type BatchGetAssetPropertyValueOutput struct {

	// A list of the errors (if any) associated with the batch request. Each error
	// entry contains the entryId of the entry that failed.
	//
	// This member is required.
	ErrorEntries []types.BatchGetAssetPropertyValueErrorEntry

	// A list of entries that were not processed by this batch request. because these
	// entries had been completely processed by previous paginated requests. Each
	// skipped entry contains the entryId of the entry that skipped.
	//
	// This member is required.
	SkippedEntries []types.BatchGetAssetPropertyValueSkippedEntry

	// A list of entries that were processed successfully by this batch request. Each
	// success entry contains the entryId of the entry that succeeded and the latest
	// query result.
	//
	// This member is required.
	SuccessEntries []types.BatchGetAssetPropertyValueSuccessEntry

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

type BatchGetAssetPropertyValuePaginator added in v1.21.0 

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

BatchGetAssetPropertyValuePaginator is a paginator for BatchGetAssetPropertyValue

func NewBatchGetAssetPropertyValuePaginator added in v1.21.0 

func NewBatchGetAssetPropertyValuePaginator(client BatchGetAssetPropertyValueAPIClient, params *BatchGetAssetPropertyValueInput, optFns ...func(*BatchGetAssetPropertyValuePaginatorOptions)) *BatchGetAssetPropertyValuePaginator

NewBatchGetAssetPropertyValuePaginator returns a new BatchGetAssetPropertyValuePaginator

func (*BatchGetAssetPropertyValuePaginator) HasMorePages added in v1.21.0 

func (p *BatchGetAssetPropertyValuePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*BatchGetAssetPropertyValuePaginator) NextPage added in v1.21.0 

func (p *BatchGetAssetPropertyValuePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*BatchGetAssetPropertyValueOutput, error)

NextPage retrieves the next BatchGetAssetPropertyValue page.

type BatchGetAssetPropertyValuePaginatorOptions added in v1.21.0 

type BatchGetAssetPropertyValuePaginatorOptions struct {
	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

BatchGetAssetPropertyValuePaginatorOptions is the paginator options for BatchGetAssetPropertyValue

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

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

type Client 

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

Client provides the API client to make operations call for AWS IoT SiteWise.

func New 

func New(options Options, optFns ...func(*Options)) *Client

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 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

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

func (*Client) AssociateTimeSeriesToAssetProperty added in v1.15.0 

func (c *Client) AssociateTimeSeriesToAssetProperty(ctx context.Context, params *AssociateTimeSeriesToAssetPropertyInput, optFns ...func(*Options)) (*AssociateTimeSeriesToAssetPropertyOutput, error)

Associates a time series (data stream) with an asset property.

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 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 IoT SiteWise Monitor project.

func (*Client) BatchGetAssetPropertyAggregates added in v1.21.0 

func (c *Client) BatchGetAssetPropertyAggregates(ctx context.Context, params *BatchGetAssetPropertyAggregatesInput, optFns ...func(*Options)) (*BatchGetAssetPropertyAggregatesOutput, error)

Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see Querying aggregatesin the IoT SiteWise User Guide.

func (*Client) BatchGetAssetPropertyValue added in v1.21.0 

func (c *Client) BatchGetAssetPropertyValue(ctx context.Context, params *BatchGetAssetPropertyValueInput, optFns ...func(*Options)) (*BatchGetAssetPropertyValueOutput, error)

Gets the current value for one or more asset properties. For more information, see Querying current valuesin the IoT SiteWise User Guide.

func (*Client) BatchGetAssetPropertyValueHistory added in v1.21.0 

func (c *Client) BatchGetAssetPropertyValueHistory(ctx context.Context, params *BatchGetAssetPropertyValueHistoryInput, optFns ...func(*Options)) (*BatchGetAssetPropertyValueHistoryOutput, error)

Gets the historical values for one or more asset properties. For more information, see Querying historical valuesin the IoT SiteWise User Guide.

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 IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the APIin the IoT SiteWise User Guide.

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

  • The assetId and propertyId of an asset property.

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

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

For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1} , then storing {T1, GOOD, V2} replaces the existing TQV.

IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorizationin the IoT SiteWise User Guide.

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 identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified 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 in the 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 modelsin the IoT SiteWise User Guide.

You can create two types of asset models, ASSET_MODEL or COMPONENT_MODEL .

  • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

  • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

func (*Client) CreateAssetModelCompositeModel added in v1.33.0 

func (c *Client) CreateAssetModelCompositeModel(ctx context.Context, params *CreateAssetModelCompositeModelInput, optFns ...func(*Options)) (*CreateAssetModelCompositeModelOutput, error)

Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models, inline and component-model-based .

Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name, a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced component model provides its associated properties to any created assets. For more information, see Custom composite models (Components)in the IoT SiteWise User Guide.

Use inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are included and can't be used to create multiple assets.

To create a component-model-based model, specify the composedAssetModelId of an existing asset model with assetModelType of COMPONENT_MODEL .

To create an inline model, specify the assetModelCompositeModelProperties and don't include an composedAssetModelId .

func (*Client) CreateBulkImportJob added in v1.23.0 

func (c *Client) CreateBulkImportJob(ctx context.Context, params *CreateBulkImportJobInput, optFns ...func(*Options)) (*CreateBulkImportJobOutput, error)

Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI)in the Amazon Simple Storage Service User Guide.

Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration.

Bulk import is designed to store historical data to IoT SiteWise. It does not trigger computations or notifications on IoT SiteWise warm or cold tier storage.

func (*Client) CreateDashboard 

func (c *Client) CreateDashboard(ctx context.Context, params *CreateDashboardInput, optFns ...func(*Options)) (*CreateDashboardOutput, error)

Creates a dashboard in an 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 IoT SiteWise. For more information, see Ingesting data using a gatewayin the 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. IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions.

Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administratorsin the 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.

Make sure that the project name and description don't contain confidential information.

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 identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access to an 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 in the IoT SiteWise User Guide.

You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.

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

func (*Client) DeleteAssetModelCompositeModel added in v1.33.0 

func (c *Client) DeleteAssetModelCompositeModel(ctx context.Context, params *DeleteAssetModelCompositeModelInput, optFns ...func(*Options)) (*DeleteAssetModelCompositeModelOutput, error)

Deletes a composite model. This action can't be undone. You must delete all assets created from a composite model before you can delete the model. Also, you can't delete a composite 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 modelsin the 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 IoT SiteWise Monitor.

func (*Client) DeleteGateway 

func (c *Client) DeleteGateway(ctx context.Context, params *DeleteGatewayInput, optFns ...func(*Options)) (*DeleteGatewayOutput, error)

Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.

func (*Client) DeletePortal 

func (c *Client) DeletePortal(ctx context.Context, params *DeletePortalInput, optFns ...func(*Options)) (*DeletePortalOutput, error)

Deletes a portal from IoT SiteWise Monitor.

func (*Client) DeleteProject 

func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error)

Deletes a project from IoT SiteWise Monitor.

func (*Client) DeleteTimeSeries added in v1.15.0 

func (c *Client) DeleteTimeSeries(ctx context.Context, params *DeleteTimeSeriesInput, optFns ...func(*Options)) (*DeleteTimeSeriesOutput, error)

Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.

To identify a time series, do one of the following:

  • If the time series isn't associated with an asset property, specify the alias of the time series.

  • If the time series is associated with an asset property, specify one of the following:

  • The alias of the time series.

  • The assetId and propertyId that identifies the asset property.

func (*Client) DescribeAccessPolicy 

func (c *Client) DescribeAccessPolicy(ctx context.Context, params *DescribeAccessPolicyInput, optFns ...func(*Options)) (*DescribeAccessPolicyOutput, error)

Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.

func (*Client) DescribeAction added in v1.33.0 

func (c *Client) DescribeAction(ctx context.Context, params *DescribeActionInput, optFns ...func(*Options)) (*DescribeActionOutput, error)

Retrieves information about an action.

func (*Client) DescribeAsset 

func (c *Client) DescribeAsset(ctx context.Context, params *DescribeAssetInput, optFns ...func(*Options)) (*DescribeAssetOutput, error)

Retrieves information about an asset.

func (*Client) DescribeAssetCompositeModel added in v1.33.0 

func (c *Client) DescribeAssetCompositeModel(ctx context.Context, params *DescribeAssetCompositeModelInput, optFns ...func(*Options)) (*DescribeAssetCompositeModelOutput, error)

Retrieves information about an asset composite model (also known as an asset component). An AssetCompositeModel is an instance of an AssetModelCompositeModel . If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel.

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) DescribeAssetModelCompositeModel added in v1.33.0 

func (c *Client) DescribeAssetModelCompositeModel(ctx context.Context, params *DescribeAssetModelCompositeModelInput, optFns ...func(*Options)) (*DescribeAssetModelCompositeModelOutput, error)

Retrieves information about an asset model composite model (also known as an asset model component). For more information, see Custom composite models (Components)in the IoT SiteWise User Guide.

func (*Client) DescribeAssetProperty 

func (c *Client) DescribeAssetProperty(ctx context.Context, params *DescribeAssetPropertyInput, optFns ...func(*Options)) (*DescribeAssetPropertyOutput, error)

Retrieves information about an asset property.

When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.

This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.

func (*Client) DescribeBulkImportJob added in v1.23.0 

func (c *Client) DescribeBulkImportJob(ctx context.Context, params *DescribeBulkImportJobInput, optFns ...func(*Options)) (*DescribeBulkImportJobOutput, error)

Retrieves information about a bulk import job request. For more information, see Describe a bulk import job (CLI)in the Amazon Simple Storage Service User Guide.

func (*Client) DescribeDashboard 

func (c *Client) DescribeDashboard(ctx context.Context, params *DescribeDashboardInput, optFns ...func(*Options)) (*DescribeDashboardOutput, error)

Retrieves information about a dashboard.

func (*Client) DescribeDefaultEncryptionConfiguration added in v0.31.0 

func (c *Client) DescribeDefaultEncryptionConfiguration(ctx context.Context, params *DescribeDefaultEncryptionConfigurationInput, optFns ...func(*Options)) (*DescribeDefaultEncryptionConfigurationOutput, error)

Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, see Key managementin the IoT SiteWise User Guide.

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 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.

func (*Client) DescribeLoggingOptions 

func (c *Client) DescribeLoggingOptions(ctx context.Context, params *DescribeLoggingOptionsInput, optFns ...func(*Options)) (*DescribeLoggingOptionsOutput, error)

Retrieves the current 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) DescribeStorageConfiguration added in v1.8.0 

func (c *Client) DescribeStorageConfiguration(ctx context.Context, params *DescribeStorageConfigurationInput, optFns ...func(*Options)) (*DescribeStorageConfigurationOutput, error)

Retrieves information about the storage configuration for IoT SiteWise.

func (*Client) DescribeTimeSeries added in v1.15.0 

func (c *Client) DescribeTimeSeries(ctx context.Context, params *DescribeTimeSeriesInput, optFns ...func(*Options)) (*DescribeTimeSeriesOutput, error)

Retrieves information about a time series (data stream).

To identify a time series, do one of the following:

  • If the time series isn't associated with an asset property, specify the alias of the time series.

  • If the time series is associated with an asset property, specify one of the following:

  • The alias of the time series.

  • The assetId and propertyId that identifies the asset property.

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) DisassociateTimeSeriesFromAssetProperty added in v1.15.0 

func (c *Client) DisassociateTimeSeriesFromAssetProperty(ctx context.Context, params *DisassociateTimeSeriesFromAssetPropertyInput, optFns ...func(*Options)) (*DisassociateTimeSeriesFromAssetPropertyOutput, error)

Disassociates a time series (data stream) from an asset property.

func (*Client) ExecuteAction added in v1.33.0 

func (c *Client) ExecuteAction(ctx context.Context, params *ExecuteActionInput, optFns ...func(*Options)) (*ExecuteActionOutput, error)

Executes an action on a target resource.

func (*Client) ExecuteQuery added in v1.33.0 

func (c *Client) ExecuteQuery(ctx context.Context, params *ExecuteQueryInput, optFns ...func(*Options)) (*ExecuteQueryOutput, error)

Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.

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

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

  • The assetId and propertyId of an asset property.

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

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

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

  • The assetId and propertyId of an asset property.

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

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

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

  • The assetId and propertyId of an asset property.

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

func (*Client) GetInterpolatedAssetPropertyValues added in v1.3.0 

func (c *Client) GetInterpolatedAssetPropertyValues(ctx context.Context, params *GetInterpolatedAssetPropertyValuesInput, optFns ...func(*Options)) (*GetInterpolatedAssetPropertyValuesOutput, error)

Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data.

For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.

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.

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 identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).

func (*Client) ListActions added in v1.33.0 

func (c *Client) ListActions(ctx context.Context, params *ListActionsInput, optFns ...func(*Options)) (*ListActionsOutput, error)

Retrieves a paginated list of actions for a specific target resource.

func (*Client) ListAssetModelCompositeModels added in v1.33.0 

func (c *Client) ListAssetModelCompositeModels(ctx context.Context, params *ListAssetModelCompositeModelsInput, optFns ...func(*Options)) (*ListAssetModelCompositeModelsOutput, error)

Retrieves a paginated list of composite models associated with the asset model

func (*Client) ListAssetModelProperties added in v1.26.0 

func (c *Client) ListAssetModelProperties(ctx context.Context, params *ListAssetModelPropertiesInput, optFns ...func(*Options)) (*ListAssetModelPropertiesOutput, error)

Retrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.

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) ListAssetProperties added in v1.26.0 

func (c *Client) ListAssetProperties(ctx context.Context, params *ListAssetPropertiesInput, optFns ...func(*Options)) (*ListAssetPropertiesOutput, error)

Retrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.

func (*Client) ListAssetRelationships added in v0.31.0 

func (c *Client) ListAssetRelationships(ctx context.Context, params *ListAssetRelationshipsInput, optFns ...func(*Options)) (*ListAssetRelationshipsOutput, error)

Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.

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 ListAssetModelsto 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 associated assets.

You can use this operation to do the following:

  • CHILD - List all child assets associated to the asset.

  • PARENT - List the asset's parent asset.

func (*Client) ListBulkImportJobs added in v1.23.0 

func (c *Client) ListBulkImportJobs(ctx context.Context, params *ListBulkImportJobsInput, optFns ...func(*Options)) (*ListBulkImportJobsOutput, error)

Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI)in the IoT SiteWise User Guide.

func (*Client) ListCompositionRelationships added in v1.33.0 

func (c *Client) ListCompositionRelationships(ctx context.Context, params *ListCompositionRelationshipsInput, optFns ...func(*Options)) (*ListCompositionRelationshipsOutput, error)

Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL .

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 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 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 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 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 IoT SiteWise resource.

func (*Client) ListTimeSeries added in v1.15.0 

func (c *Client) ListTimeSeries(ctx context.Context, params *ListTimeSeriesInput, optFns ...func(*Options)) (*ListTimeSeriesOutput, error)

Retrieves a paginated list of time series (data streams).

func (*Client) Options added in v1.34.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutDefaultEncryptionConfiguration added in v0.31.0 

func (c *Client) PutDefaultEncryptionConfiguration(ctx context.Context, params *PutDefaultEncryptionConfigurationInput, optFns ...func(*Options)) (*PutDefaultEncryptionConfigurationOutput, error)

Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key managementin the IoT SiteWise User Guide.

func (*Client) PutLoggingOptions 

func (c *Client) PutLoggingOptions(ctx context.Context, params *PutLoggingOptionsInput, optFns ...func(*Options)) (*PutLoggingOptionsOutput, error)

Sets logging options for IoT SiteWise.

func (*Client) PutStorageConfiguration added in v1.8.0 

func (c *Client) PutStorageConfiguration(ctx context.Context, params *PutStorageConfigurationInput, optFns ...func(*Options)) (*PutStorageConfigurationOutput, error)

Configures storage settings for IoT SiteWise.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds tags to an 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 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 identity's access to an 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 in the 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 modelsin the IoT SiteWise User Guide.

If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.

To replace an existing asset model property with a new one with the same name , do the following:

  • Submit an UpdateAssetModel request with the entire existing property removed.

  • Submit a second UpdateAssetModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id .

func (*Client) UpdateAssetModelCompositeModel added in v1.33.0 

func (c *Client) UpdateAssetModelCompositeModel(ctx context.Context, params *UpdateAssetModelCompositeModelInput, optFns ...func(*Options)) (*UpdateAssetModelCompositeModelOutput, error)

Updates a composite 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 modelsin the IoT SiteWise User Guide.

If you remove a property from a composite asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.

To replace an existing composite asset model property with a new one with the same name , do the following:

  • Submit an UpdateAssetModelCompositeModel request with the entire existing property removed.

  • Submit a second UpdateAssetModelCompositeModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id .

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.

func (*Client) UpdateDashboard 

func (c *Client) UpdateDashboard(ctx context.Context, params *UpdateDashboardInput, optFns ...func(*Options)) (*UpdateDashboardOutput, error)

Updates an 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 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.

func (*Client) UpdatePortal 

func (c *Client) UpdatePortal(ctx context.Context, params *UpdatePortalInput, optFns ...func(*Options)) (*UpdatePortalOutput, error)

Updates an IoT SiteWise Monitor portal.

func (*Client) UpdateProject 

func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, optFns ...func(*Options)) (*UpdateProjectOutput, error)

Updates an IoT SiteWise Monitor project.

type CreateAccessPolicyInput 

type CreateAccessPolicyInput struct {

	// The identity for this access policy. Choose an IAM Identity Center user, an IAM
	// Identity Center group, or an IAM user.
	//
	// This member is required.
	AccessPolicyIdentity *types.Identity

	// 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

	// The IoT SiteWise Monitor resource for this access policy. Choose either a
	// portal or a project.
	//
	// This member is required.
	AccessPolicyResource *types.Resource

	// 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 list of key-value pairs that contain metadata for the access policy. For more
	// information, see [Tagging your IoT SiteWise resources]in the IoT SiteWise User Guide.
	//
	// [Tagging your IoT SiteWise resources]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateAccessPolicyOutput 

type CreateAccessPolicyOutput struct {

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateAssetInput 

type CreateAssetInput struct {

	// The ID of the asset model from which to create the asset. This can be either
	// the actual ID in UUID format, or else externalId: followed by the external ID,
	// if it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.
	//
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	//
	// This member is required.
	AssetModelId *string

	// A friendly name for the asset.
	//
	// This member is required.
	AssetName *string

	// A description for the asset.
	AssetDescription *string

	// An external ID to assign to the asset. The external ID must be unique within
	// your Amazon Web Services account. For more information, see [Using external IDs]in the IoT SiteWise
	// User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	AssetExternalId *string

	// The ID to assign to the asset, if desired. IoT SiteWise automatically generates
	// a unique ID for you, so this parameter is never required. However, if you prefer
	// to supply your own ID instead, you can specify it here in UUID format. If you
	// specify your own ID, it must be globally unique.
	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

	// A list of key-value pairs that contain metadata for the asset. For more
	// information, see [Tagging your IoT SiteWise resources]in the IoT SiteWise User Guide.
	//
	// [Tagging your IoT SiteWise resources]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateAssetModelCompositeModelInput added in v1.33.0 

type CreateAssetModelCompositeModelInput struct {

	// A unique name for the composite model.
	//
	// This member is required.
	AssetModelCompositeModelName *string

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

	// The ID of the asset model this composite model is a part of.
	//
	// This member is required.
	AssetModelId *string

	// A description for the composite model.
	AssetModelCompositeModelDescription *string

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

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

	// The property definitions of the composite model. For more information, see [Inline custom composite models] in
	// the IoT SiteWise User Guide.
	//
	// You can specify up to 200 properties per composite model. For more information,
	// see [Quotas]in the IoT SiteWise User Guide.
	//
	// [Inline custom composite models]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models
	// [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
	AssetModelCompositeModelProperties []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

	// The ID of a component model which is reused to create this composite model.
	ComposedAssetModelId *string

	// The expected current entity tag (ETag) for the asset model’s latest or active
	// version (specified using matchForVersionType ). The create request is rejected
	// if the tag does not match the latest or active version's current entity tag. See
	// [Optimistic locking for asset model writes]in the IoT SiteWise User Guide.
	//
	// [Optimistic locking for asset model writes]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
	IfMatch *string

	// Accepts * to reject the create request if an active version (specified using
	// matchForVersionType as ACTIVE ) already exists for the asset model.
	IfNoneMatch *string

	// Specifies the asset model version type ( LATEST or ACTIVE ) used in conjunction
	// with If-Match or If-None-Match headers to determine the target ETag for the
	// create operation.
	MatchForVersionType types.AssetModelVersionType

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

type CreateAssetModelCompositeModelOutput added in v1.33.0 

type CreateAssetModelCompositeModelOutput struct {

	// The ID of the composed asset model. You can use this ID when you call other IoT
	// SiteWise APIs.
	//
	// This member is required.
	AssetModelCompositeModelId *string

	// The path to the composite model listing the parent composite models.
	//
	// This member is required.
	AssetModelCompositeModelPath []types.AssetModelCompositeModelPathSegment

	// Contains current status information for an asset model. For more information,
	// see [Asset and model states]in the IoT SiteWise User Guide.
	//
	// [Asset and model states]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html
	//
	// This member is required.
	AssetModelStatus *types.AssetModelStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateAssetModelInput 

type CreateAssetModelInput struct {

	// A unique name for the asset model.
	//
	// This member is required.
	AssetModelName *string

	// The composite models that are part of this asset model. It groups properties
	// (such as attributes, measurements, transforms, and metrics) and child composite
	// models that model parts of your industrial equipment. Each composite model has a
	// type that defines the properties that the composite model supports. Use
	// composite models to define alarms on this asset model.
	//
	// When creating custom composite models, you need to use [CreateAssetModelCompositeModel]. For more information,
	// see [Creating custom composite models (Components)]in the IoT SiteWise User Guide.
	//
	// [CreateAssetModelCompositeModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html
	// [Creating custom composite models (Components)]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html
	AssetModelCompositeModels []types.AssetModelCompositeModelDefinition

	// A description for the asset model.
	AssetModelDescription *string

	// An external ID to assign to the asset model. The external ID must be unique
	// within your Amazon Web Services account. For more information, see [Using external IDs]in the IoT
	// SiteWise User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	AssetModelExternalId *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]in the IoT SiteWise User Guide.
	//
	// You can specify up to 10 hierarchies per asset model. For more information, see [Quotas]
	// in the IoT SiteWise User Guide.
	//
	// [Asset hierarchies]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
	// [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
	AssetModelHierarchies []types.AssetModelHierarchyDefinition

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

	// The property definitions of the asset model. For more information, see [Asset properties] in the
	// IoT SiteWise User Guide.
	//
	// You can specify up to 200 properties per asset model. For more information, see [Quotas]
	// in the IoT SiteWise User Guide.
	//
	// [Asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html
	// [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
	AssetModelProperties []types.AssetModelPropertyDefinition

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

	// 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 list of key-value pairs that contain metadata for the asset model. For more
	// information, see [Tagging your IoT SiteWise resources]in the IoT SiteWise User Guide.
	//
	// [Tagging your IoT SiteWise resources]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateAssetModelOutput 

type CreateAssetModelOutput struct {

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

	// The ID of the asset model, in UUID format. You can use this ID when you call
	// other IoT SiteWise API operations.
	//
	// This member is required.
	AssetModelId *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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateAssetOutput 

type CreateAssetOutput struct {

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

	// The ID of the asset, in UUID format. This ID uniquely identifies the asset
	// within IoT SiteWise and can be used with other IoT SiteWise API operations.
	//
	// 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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateBulkImportJobInput added in v1.23.0 

type CreateBulkImportJobInput struct {

	// The Amazon S3 destination where errors associated with the job creation request
	// are saved.
	//
	// This member is required.
	ErrorReportLocation *types.ErrorReportLocation

	// The files in the specified Amazon S3 bucket that contain your data.
	//
	// This member is required.
	Files []types.File

	// Contains the configuration information of a job, such as the file format used
	// to save data in Amazon S3.
	//
	// This member is required.
	JobConfiguration *types.JobConfiguration

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

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

	// If set to true, ingest new data into IoT SiteWise storage. Measurements with
	// notifications, metrics and transforms are computed. If set to false, historical
	// data is ingested into IoT SiteWise as is.
	AdaptiveIngestion *bool

	// If set to true, your data files is deleted from S3, after ingestion into IoT
	// SiteWise storage.
	DeleteFilesAfterImport *bool
	// contains filtered or unexported fields
}

type CreateBulkImportJobOutput added in v1.23.0 

type CreateBulkImportJobOutput struct {

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

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDashboardInput 

type CreateDashboardInput struct {

	// The dashboard definition specified in a JSON literal. For detailed information,
	// see [Creating dashboards (CLI)]in the IoT SiteWise User Guide.
	//
	// [Creating dashboards (CLI)]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html
	//
	// This member is required.
	DashboardDefinition *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 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 dashboard.
	DashboardDescription *string

	// A list of key-value pairs that contain metadata for the dashboard. For more
	// information, see [Tagging your IoT SiteWise resources]in the IoT SiteWise User Guide.
	//
	// [Tagging your IoT SiteWise resources]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateDashboardOutput 

type CreateDashboardOutput struct {

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateGatewayInput 

type CreateGatewayInput struct {

	// A unique name for the gateway.
	//
	// This member is required.
	GatewayName *string

	// 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 IoT SiteWise resources]in the IoT SiteWise User Guide.
	//
	// [Tagging your IoT SiteWise resources]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateGatewayOutput 

type CreateGatewayOutput struct {

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

	// The ID of the gateway device. You can use this ID when you call other IoT
	// SiteWise API operations.
	//
	// This member is required.
	GatewayId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreatePortalInput 

type CreatePortalInput struct {

	// The Amazon Web Services administrator's contact email address.
	//
	// This member is required.
	PortalContactEmail *string

	// A friendly name for the portal.
	//
	// This member is required.
	PortalName *string

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

	// Contains the configuration information of an alarm created in an IoT SiteWise
	// Monitor portal. You can use the alarm to monitor an asset property and get
	// notified when the asset property value is outside a specified range. For more
	// information, see [Monitoring with alarms]in the IoT SiteWise Application Guide.
	//
	// [Monitoring with alarms]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
	Alarms *types.Alarms

	// 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 email address that sends alarm notifications.
	//
	// If you use the [IoT Events managed Lambda function] to manage your emails, you must [verify the sender email address in Amazon SES].
	//
	// [IoT Events managed Lambda function]: https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html
	// [verify the sender email address in Amazon SES]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html
	NotificationSenderEmail *string

	// The service to use to authenticate users to the portal. Choose from the
	// following options:
	//
	//   - SSO – The portal uses IAM Identity Center to authenticate users and manage
	//   user permissions. Before you can create a portal that uses IAM Identity Center,
	//   you must enable IAM Identity Center. For more information, see [Enabling IAM Identity Center]in the IoT
	//   SiteWise User Guide. This option is only available in Amazon Web Services
	//   Regions other than the China Regions.
	//
	//   - IAM – The portal uses Identity and Access Management to authenticate users
	//   and manage user permissions.
	//
	// You can't change this value after you create a portal.
	//
	// Default: SSO
	//
	// [Enabling IAM Identity Center]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso
	PortalAuthMode types.AuthMode

	// A description for the portal.
	PortalDescription *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 list of key-value pairs that contain metadata for the portal. For more
	// information, see [Tagging your IoT SiteWise resources]in the IoT SiteWise User Guide.
	//
	// [Tagging your IoT SiteWise resources]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreatePortalOutput 

type CreatePortalOutput struct {

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

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

	// The URL for the IoT SiteWise Monitor portal. You can use this URL to access
	// portals that use IAM Identity Center for authentication. For portals that use
	// IAM for authentication, you must use the IoT SiteWise console to get a URL that
	// you can use to access the portal.
	//
	// This member is required.
	PortalStartUrl *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 associated IAM Identity Center application ID, if the portal uses IAM
	// Identity Center.
	//
	// This member is required.
	SsoApplicationId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateProjectInput 

type CreateProjectInput struct {

	// The ID of the portal in which to create the project.
	//
	// This member is required.
	PortalId *string

	// A friendly name for the project.
	//
	// This member is required.
	ProjectName *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 project.
	ProjectDescription *string

	// A list of key-value pairs that contain metadata for the project. For more
	// information, see [Tagging your IoT SiteWise resources]in the IoT SiteWise User Guide.
	//
	// [Tagging your IoT SiteWise resources]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateProjectOutput 

type CreateProjectOutput struct {

	// The [ARN] of the project, which has the following format.
	//
	//     arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
	//
	// [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// 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
	// contains filtered or unexported fields
}

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

type DeleteAccessPolicyOutput 

type DeleteAccessPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAssetInput 

type DeleteAssetInput struct {

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

type DeleteAssetModelCompositeModelInput added in v1.33.0 

type DeleteAssetModelCompositeModelInput struct {

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

	// The ID of the asset model, in UUID format.
	//
	// This member is required.
	AssetModelId *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 expected current entity tag (ETag) for the asset model’s latest or active
	// version (specified using matchForVersionType ). The delete request is rejected
	// if the tag does not match the latest or active version's current entity tag. See
	// [Optimistic locking for asset model writes]in the IoT SiteWise User Guide.
	//
	// [Optimistic locking for asset model writes]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
	IfMatch *string

	// Accepts * to reject the delete request if an active version (specified using
	// matchForVersionType as ACTIVE ) already exists for the asset model.
	IfNoneMatch *string

	// Specifies the asset model version type ( LATEST or ACTIVE ) used in conjunction
	// with If-Match or If-None-Match headers to determine the target ETag for the
	// delete operation.
	MatchForVersionType types.AssetModelVersionType
	// contains filtered or unexported fields
}

type DeleteAssetModelCompositeModelOutput added in v1.33.0 

type DeleteAssetModelCompositeModelOutput struct {

	// Contains current status information for an asset model. For more information,
	// see [Asset and model states]in the IoT SiteWise User Guide.
	//
	// [Asset and model states]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html
	//
	// This member is required.
	AssetModelStatus *types.AssetModelStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAssetModelInput 

type DeleteAssetModelInput struct {

	// The ID of the asset model to delete. This can be either the actual ID in UUID
	// format, or else externalId: followed by the external ID, if it has one. For
	// more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.
	//
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	//
	// This member is required.
	AssetModelId *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 expected current entity tag (ETag) for the asset model’s latest or active
	// version (specified using matchForVersionType ). The delete request is rejected
	// if the tag does not match the latest or active version's current entity tag. See
	// [Optimistic locking for asset model writes]in the IoT SiteWise User Guide.
	//
	// [Optimistic locking for asset model writes]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
	IfMatch *string

	// Accepts * to reject the delete request if an active version (specified using
	// matchForVersionType as ACTIVE ) already exists for the asset model.
	IfNoneMatch *string

	// Specifies the asset model version type ( LATEST or ACTIVE ) used in conjunction
	// with If-Match or If-None-Match headers to determine the target ETag for the
	// delete operation.
	MatchForVersionType types.AssetModelVersionType
	// contains filtered or unexported fields
}

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

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

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

type DeleteDashboardOutput 

type DeleteDashboardOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteGatewayInput 

type DeleteGatewayInput struct {

	// The ID of the gateway to delete.
	//
	// This member is required.
	GatewayId *string
	// contains filtered or unexported fields
}

type DeleteGatewayOutput 

type DeleteGatewayOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

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

type DeleteProjectInput 

type DeleteProjectInput struct {

	// The ID of the project.
	//
	// 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
	// contains filtered or unexported fields
}

type DeleteProjectOutput 

type DeleteProjectOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteTimeSeriesInput added in v1.15.0 

type DeleteTimeSeriesInput struct {

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

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

	// The ID of the asset property. This can be either the actual ID in UUID format,
	// or else externalId: followed by the external ID, if it has one. For more
	// information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.
	//
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	PropertyId *string
	// contains filtered or unexported fields
}

type DeleteTimeSeriesOutput added in v1.15.0 

type DeleteTimeSeriesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAccessPolicyInput 

type DescribeAccessPolicyInput struct {

	// The ID of the access policy.
	//
	// This member is required.
	AccessPolicyId *string
	// contains filtered or unexported fields
}

type DescribeAccessPolicyOutput 

type DescribeAccessPolicyOutput struct {

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

	// The date the access policy was created, in Unix epoch time.
	//
	// This member is required.
	AccessPolicyCreationDate *time.Time

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

	// The identity (IAM Identity Center user, IAM Identity Center group, or IAM user)
	// to which this access policy applies.
	//
	// This member is required.
	AccessPolicyIdentity *types.Identity

	// 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 IoT SiteWise Monitor resource (portal or project) to which this access
	// policy provides access.
	//
	// This member is required.
	AccessPolicyResource *types.Resource

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeActionInput added in v1.33.0 

type DescribeActionInput struct {

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

type DescribeActionOutput added in v1.33.0 

type DescribeActionOutput struct {

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

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

	// The JSON payload of the action.
	//
	// This member is required.
	ActionPayload *types.ActionPayload

	// The time the action was executed.
	//
	// This member is required.
	ExecutionTime *time.Time

	// The resource the action will be taken on.
	//
	// This member is required.
	TargetResource *types.TargetResource

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAssetAPIClient added in v0.31.0 

type DescribeAssetAPIClient interface {
	DescribeAsset(context.Context, *DescribeAssetInput, ...func(*Options)) (*DescribeAssetOutput, error)
}

DescribeAssetAPIClient is a client that implements the DescribeAsset operation.

type DescribeAssetCompositeModelInput added in v1.33.0 

type DescribeAssetCompositeModelInput struct {

	// The ID of a composite model on this asset. This can be either the actual ID in
	// UUID format, or else externalId: followed by the external ID, if it has one.
	// For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.
	//
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	//
	// This member is required.
	AssetCompositeModelId *string

	// The ID of the asset. This can be either the actual ID in UUID format, or else
	// externalId: followed by the external ID, if it has one. For more information,
	// see [Referencing objects with external IDs]in the IoT SiteWise User Guide.
	//
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	//
	// This member is required.
	AssetId *string
	// contains filtered or unexported fields
}

type DescribeAssetCompositeModelOutput added in v1.33.0 

type DescribeAssetCompositeModelOutput struct {

	// A description for the composite model.
	//
	// This member is required.
	AssetCompositeModelDescription *string

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

	// The unique, friendly name for the composite model.
	//
	// This member is required.
	AssetCompositeModelName *string

	// The path to the composite model listing the parent composite models.
	//
	// This member is required.
	AssetCompositeModelPath []types.AssetCompositeModelPathSegment

	// The property definitions of the composite model that was used to create the
	// asset.
	//
	// This member is required.
	AssetCompositeModelProperties []types.AssetProperty

	// The list of composite model summaries.
	//
	// This member is required.
	AssetCompositeModelSummaries []types.AssetCompositeModelSummary

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

	// The ID of the asset, in UUID format. This ID uniquely identifies the asset
	// within IoT SiteWise and can be used with other IoT SiteWise APIs.
	//
	// This member is required.
	AssetId *string

	// The available actions for a composite model on this asset.
	ActionDefinitions []types.ActionDefinition

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAssetInput 

type DescribeAssetInput struct {

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

	//  Whether or not to exclude asset properties from the response.
	ExcludeProperties bool
	// contains filtered or unexported fields
}

type DescribeAssetModelAPIClient added in v0.31.0 

type DescribeAssetModelAPIClient interface {
	DescribeAssetModel(context.Context, *DescribeAssetModelInput, ...func(*Options)) (*DescribeAssetModelOutput, error)
}

DescribeAssetModelAPIClient is a client that implements the DescribeAssetModel operation.

type DescribeAssetModelCompositeModelInput added in v1.33.0 

type DescribeAssetModelCompositeModelInput struct {

	// The ID of a composite model on this asset model. This can be either the actual
	// ID in UUID format, or else externalId: followed by the external ID, if it has
	// one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.
	//
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	//
	// This member is required.
	AssetModelCompositeModelId *string

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

	// The version alias that specifies the latest or active version of the asset
	// model. The details are returned in the response. The default value is LATEST .
	// See [Asset model versions]in the IoT SiteWise User Guide.
	//
	// [Asset model versions]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html
	AssetModelVersion *string
	// contains filtered or unexported fields
}

type DescribeAssetModelCompositeModelOutput added in v1.33.0 

type DescribeAssetModelCompositeModelOutput struct {

	// The description for the composite model.
	//
	// This member is required.
	AssetModelCompositeModelDescription *string

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

	// The unique, friendly name for the composite model.
	//
	// This member is required.
	AssetModelCompositeModelName *string

	// The path to the composite model listing the parent composite models.
	//
	// This member is required.
	AssetModelCompositeModelPath []types.AssetModelCompositeModelPathSegment

	// The property definitions of the composite model.
	//
	// This member is required.
	AssetModelCompositeModelProperties []types.AssetModelProperty

	// The list of composite model summaries for the composite model.
	//
	// This member is required.
	AssetModelCompositeModelSummaries []types.AssetModelCompositeModelSummary

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

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

	// The available actions for a composite model on this asset model.
	ActionDefinitions []types.ActionDefinition

	// The external ID of a composite model on this asset model.
	AssetModelCompositeModelExternalId *string

	// Metadata for the composition relationship established by using
	// composedAssetModelId in [CreateAssetModelCompositeModel]CreateAssetModelCompositeModel . For instance, an array
	// detailing the path of the composition relationship for this composite model.
	//
	// [CreateAssetModelCompositeModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html
	CompositionDetails *types.CompositionDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAssetModelInput 

type DescribeAssetModelInput struct {

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

	// The version alias that specifies the latest or active version of the asset
	// model. The details are returned in the response. The default value is LATEST .
	// See [Asset model versions]in the IoT SiteWise User Guide.
	//
	// [Asset model versions]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html
	AssetModelVersion *string

	//  Whether or not to exclude asset model properties from the response.
	ExcludeProperties bool
	// contains filtered or unexported fields
}

type DescribeAssetModelOutput 

type DescribeAssetModelOutput struct {

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

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

	// The asset model's description.
	//
	// This member is required.
	AssetModelDescription *string

	// 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, in UUID format.
	//
	// This member is required.
	AssetModelId *string

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

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

	// The list of asset properties for the asset model.
	//
	// This object doesn't include properties that you define in composite models. You
	// can find composite model properties in the assetModelCompositeModels object.
	//
	// This member is required.
	AssetModelProperties []types.AssetModelProperty

	// The current status of the asset model, which contains a state and any error
	// message.
	//
	// This member is required.
	AssetModelStatus *types.AssetModelStatus

	// The list of the immediate child custom composite model summaries for the asset
	// model.
	AssetModelCompositeModelSummaries []types.AssetModelCompositeModelSummary

	// The list of built-in composite models for the asset model, such as those with
	// those of type AWS/ALARMS .
	AssetModelCompositeModels []types.AssetModelCompositeModel

	// The external ID of the asset model, if any.
	AssetModelExternalId *string

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

	// The version of the asset model. See [Asset model versions] in the IoT SiteWise User Guide.
	//
	// [Asset model versions]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html
	AssetModelVersion *string

	// The entity tag (ETag) is a hash of the retrieved version of the asset model.
	// It's used to make concurrent updates safely to the resource. See [Optimistic locking for asset model writes]in the IoT
	// SiteWise User Guide.
	//
	// See [Optimistic locking for asset model writes] in the IoT SiteWise User Guide.
	//
	// [Optimistic locking for asset model writes]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
	ETag *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAssetOutput 

type DescribeAssetOutput struct {

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

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

	// 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 ID of the asset, in UUID format.
	//
	// This member is required.
	AssetId *string

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

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

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

	// The list of asset properties for the asset.
	//
	// This object doesn't include properties that you define in composite models. You
	// can find composite model properties in the assetCompositeModels object.
	//
	// This member is required.
	AssetProperties []types.AssetProperty

	// The current status of the asset, which contains a state and any error message.
	//
	// This member is required.
	AssetStatus *types.AssetStatus

	// The list of the immediate child custom composite model summaries for the asset.
	AssetCompositeModelSummaries []types.AssetCompositeModelSummary

	// The composite models for the asset.
	AssetCompositeModels []types.AssetCompositeModel

	// A description for the asset.
	AssetDescription *string

	// The external ID of the asset, if any.
	AssetExternalId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAssetPropertyInput 

type DescribeAssetPropertyInput struct {

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

	// The ID of the asset property. This can be either the actual ID in UUID format,
	// or else externalId: followed by the external ID, if it has one. For more
	// information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.
	//
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	//
	// This member is required.
	PropertyId *string
	// contains filtered or unexported fields
}

type DescribeAssetPropertyOutput 

type DescribeAssetPropertyOutput struct {

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

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

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

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

	// The asset property's definition, alias, and notification state.
	//
	// This response includes this object for normal asset properties. If you describe
	// an asset property in a composite model, this response includes the asset
	// property information in compositeModel .
	AssetProperty *types.Property

	// The composite model that declares this asset property, if this asset property
	// exists in a composite model.
	CompositeModel *types.CompositeModelProperty

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeBulkImportJobInput added in v1.23.0 

type DescribeBulkImportJobInput struct {

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

type DescribeBulkImportJobOutput added in v1.23.0 

type DescribeBulkImportJobOutput struct {

	// The Amazon S3 destination where errors associated with the job creation request
	// are saved.
	//
	// This member is required.
	ErrorReportLocation *types.ErrorReportLocation

	// The files in the specified Amazon S3 bucket that contain your data.
	//
	// This member is required.
	Files []types.File

	// Contains the configuration information of a job, such as the file format used
	// to save data in Amazon S3.
	//
	// This member is required.
	JobConfiguration *types.JobConfiguration

	// The date the job was created, in Unix epoch TIME.
	//
	// This member is required.
	JobCreationDate *time.Time

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

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

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

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

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

	// If set to true, ingest new data into IoT SiteWise storage. Measurements with
	// notifications, metrics and transforms are computed. If set to false, historical
	// data is ingested into IoT SiteWise as is.
	AdaptiveIngestion *bool

	// If set to true, your data files is deleted from S3, after ingestion into IoT
	// SiteWise storage.
	DeleteFilesAfterImport *bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDashboardInput 

type DescribeDashboardInput struct {

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

type DescribeDashboardOutput 

type DescribeDashboardOutput struct {

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

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

	// The dashboard's definition JSON literal. For detailed information, see [Creating dashboards (CLI)] in the
	// IoT SiteWise User Guide.
	//
	// [Creating dashboards (CLI)]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html
	//
	// This member is required.
	DashboardDefinition *string

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

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

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

	// The ID of the project that the dashboard is in.
	//
	// This member is required.
	ProjectId *string

	// The dashboard's description.
	DashboardDescription *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeDefaultEncryptionConfigurationInput added in v0.31.0 

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

type DescribeDefaultEncryptionConfigurationOutput added in v0.31.0 

type DescribeDefaultEncryptionConfigurationOutput struct {

	// The status of the account configuration. This contains the ConfigurationState .
	// If there's an error, it also contains the ErrorDetails .
	//
	// This member is required.
	ConfigurationStatus *types.ConfigurationStatus

	// The type of encryption used for the encryption configuration.
	//
	// This member is required.
	EncryptionType types.EncryptionType

	// The key ARN of the customer managed key used for KMS encryption if you use
	// KMS_BASED_ENCRYPTION .
	KmsKeyArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeGatewayCapabilityConfigurationInput 

type DescribeGatewayCapabilityConfigurationInput struct {

	// The namespace of the capability configuration. For example, if you configure
	// OPC-UA sources from the IoT SiteWise console, your OPC-UA capability
	// configuration has the namespace iotsitewise:opcuacollector:version , where
	// version is a number such as 1 .
	//
	// This member is required.
	CapabilityNamespace *string

	// The ID of the gateway that defines the capability configuration.
	//
	// This member is required.
	GatewayId *string
	// contains filtered or unexported fields
}

type DescribeGatewayCapabilityConfigurationOutput 

type DescribeGatewayCapabilityConfigurationOutput struct {

	// The JSON document that defines the gateway capability's configuration. For more
	// information, see [Configuring data sources (CLI)]in the IoT SiteWise User Guide.
	//
	// [Configuring data sources (CLI)]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli
	//
	// This member is required.
	CapabilityConfiguration *string

	// The namespace of the gateway capability.
	//
	// This member is required.
	CapabilityNamespace *string

	// The synchronization status of the capability configuration. The sync status can
	// be one of the following:
	//
	//   - IN_SYNC – The gateway is running the capability configuration.
	//
	//   - OUT_OF_SYNC – The gateway hasn't received the capability configuration.
	//
	//   - SYNC_FAILED – The gateway rejected the capability configuration.
	//
	// This member is required.
	CapabilitySyncStatus 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
	// contains filtered or unexported fields
}

type DescribeGatewayInput 

type DescribeGatewayInput struct {

	// The ID of the gateway device.
	//
	// This member is required.
	GatewayId *string
	// contains filtered or unexported fields
}

type DescribeGatewayOutput 

type DescribeGatewayOutput struct {

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

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

	// A list of gateway capability summaries that each contain a namespace and
	// status. Each gateway capability defines data sources for the gateway. To
	// retrieve a capability configuration's definition, use [DescribeGatewayCapabilityConfiguration].
	//
	// [DescribeGatewayCapabilityConfiguration]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html
	//
	// This member is required.
	GatewayCapabilitySummaries []types.GatewayCapabilitySummary

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

	// The name of the gateway.
	//
	// This member is required.
	GatewayName *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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeLoggingOptionsInput 

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

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

type DescribePortalAPIClient added in v0.31.0 

type DescribePortalAPIClient interface {
	DescribePortal(context.Context, *DescribePortalInput, ...func(*Options)) (*DescribePortalOutput, error)
}

DescribePortalAPIClient is a client that implements the DescribePortal operation.

type DescribePortalInput 

type DescribePortalInput struct {

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

type DescribePortalOutput 

type DescribePortalOutput struct {

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

	// The IAM Identity Center application generated client ID (used with IAM Identity
	// Center API operations). IoT SiteWise includes portalClientId for only portals
	// that use IAM Identity Center to authenticate users.
	//
	// This member is required.
	PortalClientId *string

	// The Amazon Web Services administrator's contact email address.
	//
	// This member is required.
	PortalContactEmail *string

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

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

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

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

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

	// The current status of the portal, which contains a state and any error message.
	//
	// This member is required.
	PortalStatus *types.PortalStatus

	// Contains the configuration information of an alarm created in an IoT SiteWise
	// Monitor portal.
	Alarms *types.Alarms

	// The email address that sends alarm notifications.
	NotificationSenderEmail *string

	// The service to use to authenticate users to the portal.
	PortalAuthMode types.AuthMode

	// The portal's description.
	PortalDescription *string

	// The portal's logo image, which is available at a URL.
	PortalLogoImageLocation *types.ImageLocation

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeProjectInput 

type DescribeProjectInput struct {

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

type DescribeProjectOutput 

type DescribeProjectOutput struct {

	// The ID of the portal that the project is in.
	//
	// This member is required.
	PortalId *string

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

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

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

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

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

	// The project's description.
	ProjectDescription *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeStorageConfigurationInput added in v1.8.0 

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

type DescribeStorageConfigurationOutput added in v1.8.0 

type DescribeStorageConfigurationOutput struct {

	// Contains current status information for the configuration.
	//
	// This member is required.
	ConfigurationStatus *types.ConfigurationStatus

	// The storage tier that you specified for your data. The storageType parameter
	// can be one of the following values:
	//
	//   - SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier.
	//   The hot tier is a service-managed database.
	//
	//   - MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and
	//   the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
	//
	// This member is required.
	StorageType types.StorageType

	// Contains the storage configuration for time series (data streams) that aren't
	// associated with asset properties. The disassociatedDataStorage can be one of
	// the following values:
	//
	//   - ENABLED – IoT SiteWise accepts time series that aren't associated with asset
	//   properties.
	//
	// After the disassociatedDataStorage is enabled, you can't disable it.
	//
	//   - DISABLED – IoT SiteWise doesn't accept time series (data streams) that
	//   aren't associated with asset properties.
	//
	// For more information, see [Data streams] in the IoT SiteWise User Guide.
	//
	// [Data streams]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html
	DisassociatedDataStorage types.DisassociatedDataStorageState

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

	// Contains information about the storage destination.
	MultiLayerStorage *types.MultiLayerStorage

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

	// A service managed storage tier optimized for analytical queries. It stores
	// periodically uploaded, buffered and historical data ingested with the
	// CreaeBulkImportJob API.
	WarmTier types.WarmTierState

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeTimeSeriesInput added in v1.15.0 

type DescribeTimeSeriesInput struct {

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

	// The ID of the asset in which the asset property was created. This can be either
	// the actual ID in UUID format, or else externalId: followed by the external ID,
	// if it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.
	//
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	AssetId *string

	// The ID of the asset property. This can be either the actual ID in UUID format,
	// or else externalId: followed by the external ID, if it has one. For more
	// information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.
	//
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	PropertyId *string
	// contains filtered or unexported fields
}

type DescribeTimeSeriesOutput added in v1.15.0 

type DescribeTimeSeriesOutput struct {

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

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

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

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

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

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

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

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateAssetsInput 

type DisassociateAssetsInput struct {

	// The ID of the parent asset from which to disassociate the child asset. This can
	// be either the actual ID in UUID format, or else externalId: followed by the
	// external ID, if it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User
	// Guide.
	//
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	//
	// This member is required.
	AssetId *string

	// The ID of the child asset to disassociate. This can be either the actual ID in
	// UUID format, or else externalId: followed by the external ID, if it has one.
	// For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.
	//
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	//
	// This member is required.
	ChildAssetId *string

	// The ID of a hierarchy in the parent asset's model. (This can be either the
	// actual ID in UUID format, or else externalId: followed by the external ID, if
	// it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.)
	// 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]in the IoT SiteWise User Guide.
	//
	// [Asset hierarchies]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	//
	// 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
	// contains filtered or unexported fields
}

type DisassociateAssetsOutput 

type DisassociateAssetsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateTimeSeriesFromAssetPropertyInput added in v1.15.0 

type DisassociateTimeSeriesFromAssetPropertyInput struct {

	// The alias that identifies the time series.
	//
	// This member is required.
	Alias *string

	// The ID of the asset in which the asset property was created. This can be either
	// the actual ID in UUID format, or else externalId: followed by the external ID,
	// if it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.
	//
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	//
	// This member is required.
	AssetId *string

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

type DisassociateTimeSeriesFromAssetPropertyOutput added in v1.15.0 

type DisassociateTimeSeriesFromAssetPropertyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.30.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.30.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.30.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (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 EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.30.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.30.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type ExecuteActionInput added in v1.33.0 

type ExecuteActionInput struct {

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

	// The JSON payload of the action.
	//
	// This member is required.
	ActionPayload *types.ActionPayload

	// The resource the action will be taken on.
	//
	// This member is required.
	TargetResource *types.TargetResource

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

type ExecuteActionOutput added in v1.33.0 

type ExecuteActionOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ExecuteQueryAPIClient added in v1.33.0 

type ExecuteQueryAPIClient interface {
	ExecuteQuery(context.Context, *ExecuteQueryInput, ...func(*Options)) (*ExecuteQueryOutput, error)
}

ExecuteQueryAPIClient is a client that implements the ExecuteQuery operation.

type ExecuteQueryInput added in v1.33.0 

type ExecuteQueryInput struct {

	// The IoT SiteWise query statement.
	//
	// This member is required.
	QueryStatement *string

	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int32

	// The string that specifies the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ExecuteQueryOutput added in v1.33.0 

type ExecuteQueryOutput struct {

	// Represents a single column in the query results.
	Columns []types.ColumnInfo

	// The string that specifies the next page of results.
	NextToken *string

	// Represents a single row in the query results.
	Rows []types.Row

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ExecuteQueryPaginator added in v1.33.0 

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

ExecuteQueryPaginator is a paginator for ExecuteQuery

func NewExecuteQueryPaginator added in v1.33.0 

func NewExecuteQueryPaginator(client ExecuteQueryAPIClient, params *ExecuteQueryInput, optFns ...func(*ExecuteQueryPaginatorOptions)) *ExecuteQueryPaginator

NewExecuteQueryPaginator returns a new ExecuteQueryPaginator

func (*ExecuteQueryPaginator) HasMorePages added in v1.33.0 

func (p *ExecuteQueryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ExecuteQueryPaginator) NextPage added in v1.33.0 

func (p *ExecuteQueryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ExecuteQueryOutput, error)

NextPage retrieves the next ExecuteQuery page.

type ExecuteQueryPaginatorOptions added in v1.33.0 

type ExecuteQueryPaginatorOptions struct {
	// The maximum number of results to return at one time. The default is 25.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ExecuteQueryPaginatorOptions is the paginator options for ExecuteQuery

type GetAssetPropertyAggregatesAPIClient added in v0.30.0 

type GetAssetPropertyAggregatesAPIClient interface {
	GetAssetPropertyAggregates(context.Context, *GetAssetPropertyAggregatesInput, ...func(*Options)) (*GetAssetPropertyAggregatesOutput, error)
}

GetAssetPropertyAggregatesAPIClient is a client that implements the GetAssetPropertyAggregates operation.

type GetAssetPropertyAggregatesInput 

type GetAssetPropertyAggregatesInput struct {

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

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

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

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

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

	// The maximum number of results to return for each paginated request. A result
	// set is returned in the two cases, whichever occurs first.
	//
	//   - The size of the result set is equal to 1 MB.
	//
	//   - The number of data points in the result set is equal to the value of
	//   maxResults . The maximum value of maxResults is 2500.
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string

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

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

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

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

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

type GetAssetPropertyAggregatesPaginator added in v0.30.0 

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

GetAssetPropertyAggregatesPaginator is a paginator for GetAssetPropertyAggregates

func NewGetAssetPropertyAggregatesPaginator added in v0.30.0 

func NewGetAssetPropertyAggregatesPaginator(client GetAssetPropertyAggregatesAPIClient, params *GetAssetPropertyAggregatesInput, optFns ...func(*GetAssetPropertyAggregatesPaginatorOptions)) *GetAssetPropertyAggregatesPaginator

NewGetAssetPropertyAggregatesPaginator returns a new GetAssetPropertyAggregatesPaginator

func (*GetAssetPropertyAggregatesPaginator) HasMorePages added in v0.30.0 

func (p *GetAssetPropertyAggregatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetAssetPropertyAggregatesPaginator) NextPage added in v0.30.0 

func (p *GetAssetPropertyAggregatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetAssetPropertyAggregatesOutput, error)

NextPage retrieves the next GetAssetPropertyAggregates page.

type GetAssetPropertyAggregatesPaginatorOptions added in v0.30.0 

type GetAssetPropertyAggregatesPaginatorOptions struct {
	// The maximum number of results to return for each paginated request. A result
	// set is returned in the two cases, whichever occurs first.
	//
	//   - The size of the result set is equal to 1 MB.
	//
	//   - The number of data points in the result set is equal to the value of
	//   maxResults . The maximum value of maxResults is 2500.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetAssetPropertyAggregatesPaginatorOptions is the paginator options for GetAssetPropertyAggregates

type GetAssetPropertyValueHistoryAPIClient added in v0.30.0 

type GetAssetPropertyValueHistoryAPIClient interface {
	GetAssetPropertyValueHistory(context.Context, *GetAssetPropertyValueHistoryInput, ...func(*Options)) (*GetAssetPropertyValueHistoryOutput, error)
}

GetAssetPropertyValueHistoryAPIClient is a client that implements the GetAssetPropertyValueHistory operation.

type GetAssetPropertyValueHistoryInput 

type GetAssetPropertyValueHistoryInput struct {

	// The ID of the asset, in UUID format.
	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 maximum number of results to return for each paginated request. A result
	// set is returned in the two cases, whichever occurs first.
	//
	//   - The size of the result set is equal to 4 MB.
	//
	//   - The number of data points in the result set is equal to the value of
	//   maxResults . The maximum value of maxResults is 20000.
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string

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

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

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

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

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

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

type GetAssetPropertyValueHistoryPaginator added in v0.30.0 

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

GetAssetPropertyValueHistoryPaginator is a paginator for GetAssetPropertyValueHistory

func NewGetAssetPropertyValueHistoryPaginator added in v0.30.0 

func NewGetAssetPropertyValueHistoryPaginator(client GetAssetPropertyValueHistoryAPIClient, params *GetAssetPropertyValueHistoryInput, optFns ...func(*GetAssetPropertyValueHistoryPaginatorOptions)) *GetAssetPropertyValueHistoryPaginator

NewGetAssetPropertyValueHistoryPaginator returns a new GetAssetPropertyValueHistoryPaginator

func (*GetAssetPropertyValueHistoryPaginator) HasMorePages added in v0.30.0 

func (p *GetAssetPropertyValueHistoryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetAssetPropertyValueHistoryPaginator) NextPage added in v0.30.0 

func (p *GetAssetPropertyValueHistoryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetAssetPropertyValueHistoryOutput, error)

NextPage retrieves the next GetAssetPropertyValueHistory page.

type GetAssetPropertyValueHistoryPaginatorOptions added in v0.30.0 

type GetAssetPropertyValueHistoryPaginatorOptions struct {
	// The maximum number of results to return for each paginated request. A result
	// set is returned in the two cases, whichever occurs first.
	//
	//   - The size of the result set is equal to 4 MB.
	//
	//   - The number of data points in the result set is equal to the value of
	//   maxResults . The maximum value of maxResults is 20000.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetAssetPropertyValueHistoryPaginatorOptions is the paginator options for GetAssetPropertyValueHistory

type GetAssetPropertyValueInput 

type GetAssetPropertyValueInput struct {

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

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

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

type GetAssetPropertyValueOutput 

type GetAssetPropertyValueOutput struct {

	// The current asset property value.
	PropertyValue *types.AssetPropertyValue

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetInterpolatedAssetPropertyValuesAPIClient added in v1.3.0 

type GetInterpolatedAssetPropertyValuesAPIClient interface {
	GetInterpolatedAssetPropertyValues(context.Context, *GetInterpolatedAssetPropertyValuesInput, ...func(*Options)) (*GetInterpolatedAssetPropertyValuesOutput, error)
}

GetInterpolatedAssetPropertyValuesAPIClient is a client that implements the GetInterpolatedAssetPropertyValues operation.

type GetInterpolatedAssetPropertyValuesInput added in v1.3.0 

type GetInterpolatedAssetPropertyValuesInput struct {

	// The inclusive end of the range from which to interpolate data, expressed in
	// seconds in Unix epoch time.
	//
	// This member is required.
	EndTimeInSeconds *int64

	// The time interval in seconds over which to interpolate data. Each interval
	// starts when the previous one ends.
	//
	// This member is required.
	IntervalInSeconds *int64

	// The quality of the asset property value. You can use this parameter as a filter
	// to choose only the asset property values that have a specific quality.
	//
	// This member is required.
	Quality types.Quality

	// The exclusive start of the range from which to interpolate data, expressed in
	// seconds in Unix epoch time.
	//
	// This member is required.
	StartTimeInSeconds *int64

	// The interpolation type.
	//
	// Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION
	//
	//   - LINEAR_INTERPOLATION – Estimates missing data using [linear interpolation].
	//
	// For example, you can use this operation to return the interpolated temperature
	//   values for a wind turbine every 24 hours over a duration of 7 days. If the
	//   interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the first
	//   interpolated value on July 2, 2021, at 9 AM, the second interpolated value on
	//   July 3, 2021, at 9 AM, and so on.
	//
	//   - LOCF_INTERPOLATION – Estimates missing data using last observation carried
	//   forward interpolation
	//
	// If no data point is found for an interval, IoT SiteWise returns the last
	//   observed data point for the previous interval and carries forward this
	//   interpolated value until a new data point is found.
	//
	// For example, you can get the state of an on-off valve every 24 hours over a
	//   duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT
	//   SiteWise returns the last observed data point between July 1, 2021, at 9 AM and
	//   July 2, 2021, at 9 AM as the first interpolated value. If a data point isn't
	//   found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value
	//   for the rest of the days.
	//
	// [linear interpolation]: https://en.wikipedia.org/wiki/Linear_interpolation
	//
	// This member is required.
	Type *string

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

	// The nanosecond offset converted from endTimeInSeconds .
	EndTimeOffsetInNanos *int32

	// The query interval for the window, in seconds. IoT SiteWise computes each
	// interpolated value by using data points from the timestamp of each interval,
	// minus the window to the timestamp of each interval plus the window. If not
	// specified, the window ranges between the start time minus the interval and the
	// end time plus the interval.
	//
	//   - If you specify a value for the intervalWindowInSeconds parameter, the value
	//   for the type parameter must be LINEAR_INTERPOLATION .
	//
	//   - If a data point isn't found during the specified query window, IoT SiteWise
	//   won't return an interpolated value for the interval. This indicates that there's
	//   a gap in the ingested data points.
	//
	// For example, you can get the interpolated temperature values for a wind turbine
	// every 24 hours over a duration of 7 days. If the interpolation starts on July 1,
	// 2021, at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7
	// AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute
	// the first interpolated value. Next, IoT SiteWise uses the data points from 7 AM
	// (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to compute the
	// second interpolated value, and so on.
	IntervalWindowInSeconds *int64

	// The maximum number of results to return for each paginated request. If not
	// specified, the default value is 10.
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string

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

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

	// The nanosecond offset converted from startTimeInSeconds .
	StartTimeOffsetInNanos *int32
	// contains filtered or unexported fields
}

type GetInterpolatedAssetPropertyValuesOutput added in v1.3.0 

type GetInterpolatedAssetPropertyValuesOutput struct {

	// The requested interpolated values.
	//
	// This member is required.
	InterpolatedAssetPropertyValues []types.InterpolatedAssetPropertyValue

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

type GetInterpolatedAssetPropertyValuesPaginator added in v1.3.0 

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

GetInterpolatedAssetPropertyValuesPaginator is a paginator for GetInterpolatedAssetPropertyValues

func NewGetInterpolatedAssetPropertyValuesPaginator added in v1.3.0 

func NewGetInterpolatedAssetPropertyValuesPaginator(client GetInterpolatedAssetPropertyValuesAPIClient, params *GetInterpolatedAssetPropertyValuesInput, optFns ...func(*GetInterpolatedAssetPropertyValuesPaginatorOptions)) *GetInterpolatedAssetPropertyValuesPaginator

NewGetInterpolatedAssetPropertyValuesPaginator returns a new GetInterpolatedAssetPropertyValuesPaginator

func (*GetInterpolatedAssetPropertyValuesPaginator) HasMorePages added in v1.3.0 

func (p *GetInterpolatedAssetPropertyValuesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetInterpolatedAssetPropertyValuesPaginator) NextPage added in v1.3.0 

func (p *GetInterpolatedAssetPropertyValuesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetInterpolatedAssetPropertyValuesOutput, error)

NextPage retrieves the next GetInterpolatedAssetPropertyValues page.

type GetInterpolatedAssetPropertyValuesPaginatorOptions added in v1.3.0 

type GetInterpolatedAssetPropertyValuesPaginatorOptions struct {
	// The maximum number of results to return for each paginated request. If not
	// specified, the default value is 10.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetInterpolatedAssetPropertyValuesPaginatorOptions is the paginator options for GetInterpolatedAssetPropertyValues

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListAccessPoliciesAPIClient added in v0.30.0 

type ListAccessPoliciesAPIClient interface {
	ListAccessPolicies(context.Context, *ListAccessPoliciesInput, ...func(*Options)) (*ListAccessPoliciesOutput, error)
}

ListAccessPoliciesAPIClient is a client that implements the ListAccessPolicies operation.

type ListAccessPoliciesInput 

type ListAccessPoliciesInput struct {

	// The ARN of the IAM user. For more information, see [IAM ARNs] in the IAM User Guide. This
	// parameter is required if you specify IAM for identityType .
	//
	// [IAM ARNs]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html
	IamArn *string

	// The ID of the identity. This parameter is required if you specify USER or GROUP
	// for identityType .
	IdentityId *string

	// The type of identity (IAM Identity Center user, IAM Identity Center group, or
	// IAM user). This parameter is required if you specify identityId .
	IdentityType types.IdentityType

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int32

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

type ListAccessPoliciesOutput 

type ListAccessPoliciesOutput struct {

	// A list that summarizes each access policy.
	//
	// This member is required.
	AccessPolicySummaries []types.AccessPolicySummary

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

type ListAccessPoliciesPaginator added in v0.30.0 

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

ListAccessPoliciesPaginator is a paginator for ListAccessPolicies

func NewListAccessPoliciesPaginator added in v0.30.0 

func NewListAccessPoliciesPaginator(client ListAccessPoliciesAPIClient, params *ListAccessPoliciesInput, optFns ...func(*ListAccessPoliciesPaginatorOptions)) *ListAccessPoliciesPaginator

NewListAccessPoliciesPaginator returns a new ListAccessPoliciesPaginator

func (*ListAccessPoliciesPaginator) HasMorePages added in v0.30.0 

func (p *ListAccessPoliciesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAccessPoliciesPaginator) NextPage added in v0.30.0 

func (p *ListAccessPoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAccessPoliciesOutput, error)

NextPage retrieves the next ListAccessPolicies page.

type ListAccessPoliciesPaginatorOptions added in v0.30.0 

type ListAccessPoliciesPaginatorOptions struct {
	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAccessPoliciesPaginatorOptions is the paginator options for ListAccessPolicies

type ListActionsInput added in v1.33.0 

type ListActionsInput struct {

	// The ID of the target resource.
	//
	// This member is required.
	TargetResourceId *string

	// The type of resource.
	//
	// This member is required.
	TargetResourceType types.TargetResourceType

	// The maximum number of results to return for each paginated request.
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListActionsOutput added in v1.33.0 

type ListActionsOutput struct {

	// A list that summarizes the actions associated with the specified asset.
	//
	// This member is required.
	ActionSummaries []types.ActionSummary

	// The token for the next set of results, or null if there are no additional
	// results.
	//
	// This member is required.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAssetModelCompositeModelsAPIClient added in v1.33.0 

type ListAssetModelCompositeModelsAPIClient interface {
	ListAssetModelCompositeModels(context.Context, *ListAssetModelCompositeModelsInput, ...func(*Options)) (*ListAssetModelCompositeModelsOutput, error)
}

ListAssetModelCompositeModelsAPIClient is a client that implements the ListAssetModelCompositeModels operation.

type ListAssetModelCompositeModelsInput added in v1.33.0 

type ListAssetModelCompositeModelsInput struct {

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

	// The version alias that specifies the latest or active version of the asset
	// model. The details are returned in the response. The default value is LATEST .
	// See [Asset model versions]in the IoT SiteWise User Guide.
	//
	// [Asset model versions]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html
	AssetModelVersion *string

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAssetModelCompositeModelsOutput added in v1.33.0 

type ListAssetModelCompositeModelsOutput struct {

	// A list that summarizes each composite model.
	//
	// This member is required.
	AssetModelCompositeModelSummaries []types.AssetModelCompositeModelSummary

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

type ListAssetModelCompositeModelsPaginator added in v1.33.0 

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

ListAssetModelCompositeModelsPaginator is a paginator for ListAssetModelCompositeModels

func NewListAssetModelCompositeModelsPaginator added in v1.33.0 

func NewListAssetModelCompositeModelsPaginator(client ListAssetModelCompositeModelsAPIClient, params *ListAssetModelCompositeModelsInput, optFns ...func(*ListAssetModelCompositeModelsPaginatorOptions)) *ListAssetModelCompositeModelsPaginator

NewListAssetModelCompositeModelsPaginator returns a new ListAssetModelCompositeModelsPaginator

func (*ListAssetModelCompositeModelsPaginator) HasMorePages added in v1.33.0 

func (p *ListAssetModelCompositeModelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssetModelCompositeModelsPaginator) NextPage added in v1.33.0 

func (p *ListAssetModelCompositeModelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssetModelCompositeModelsOutput, error)

NextPage retrieves the next ListAssetModelCompositeModels page.

type ListAssetModelCompositeModelsPaginatorOptions added in v1.33.0 

type ListAssetModelCompositeModelsPaginatorOptions struct {
	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAssetModelCompositeModelsPaginatorOptions is the paginator options for ListAssetModelCompositeModels

type ListAssetModelPropertiesAPIClient added in v1.26.0 

type ListAssetModelPropertiesAPIClient interface {
	ListAssetModelProperties(context.Context, *ListAssetModelPropertiesInput, ...func(*Options)) (*ListAssetModelPropertiesOutput, error)
}

ListAssetModelPropertiesAPIClient is a client that implements the ListAssetModelProperties operation.

type ListAssetModelPropertiesInput added in v1.26.0 

type ListAssetModelPropertiesInput struct {

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

	// The version alias that specifies the latest or active version of the asset
	// model. The details are returned in the response. The default value is LATEST .
	// See [Asset model versions]in the IoT SiteWise User Guide.
	//
	// [Asset model versions]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html
	AssetModelVersion *string

	//  Filters the requested list of asset model properties. You can choose one of
	// the following options:
	//
	//   - ALL – The list includes all asset model properties for a given asset model
	//   ID.
	//
	//   - BASE – The list includes only base asset model properties for a given asset
	//   model ID.
	//
	// Default: BASE
	Filter types.ListAssetModelPropertiesFilter

	// The maximum number of results to return for each paginated request. If not
	// specified, the default value is 50.
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAssetModelPropertiesOutput added in v1.26.0 

type ListAssetModelPropertiesOutput struct {

	// A list that summarizes the properties associated with the specified asset model.
	//
	// This member is required.
	AssetModelPropertySummaries []types.AssetModelPropertySummary

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

type ListAssetModelPropertiesPaginator added in v1.26.0 

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

ListAssetModelPropertiesPaginator is a paginator for ListAssetModelProperties

func NewListAssetModelPropertiesPaginator added in v1.26.0 

func NewListAssetModelPropertiesPaginator(client ListAssetModelPropertiesAPIClient, params *ListAssetModelPropertiesInput, optFns ...func(*ListAssetModelPropertiesPaginatorOptions)) *ListAssetModelPropertiesPaginator

NewListAssetModelPropertiesPaginator returns a new ListAssetModelPropertiesPaginator

func (*ListAssetModelPropertiesPaginator) HasMorePages added in v1.26.0 

func (p *ListAssetModelPropertiesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssetModelPropertiesPaginator) NextPage added in v1.26.0 

func (p *ListAssetModelPropertiesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssetModelPropertiesOutput, error)

NextPage retrieves the next ListAssetModelProperties page.

type ListAssetModelPropertiesPaginatorOptions added in v1.26.0 

type ListAssetModelPropertiesPaginatorOptions struct {
	// The maximum number of results to return for each paginated request. If not
	// specified, the default value is 50.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAssetModelPropertiesPaginatorOptions is the paginator options for ListAssetModelProperties

type ListAssetModelsAPIClient added in v0.30.0 

type ListAssetModelsAPIClient interface {
	ListAssetModels(context.Context, *ListAssetModelsInput, ...func(*Options)) (*ListAssetModelsOutput, error)
}

ListAssetModelsAPIClient is a client that implements the ListAssetModels operation.

type ListAssetModelsInput 

type ListAssetModelsInput struct {

	// The type of asset model. If you don't provide an assetModelTypes , all types of
	// asset models are returned.
	//
	//   - ASSET_MODEL – An asset model that you can use to create assets. Can't be
	//   included as a component in another asset model.
	//
	//   - COMPONENT_MODEL – A reusable component that you can include in the
	//   composite models of other asset models. You can't create assets directly from
	//   this type of asset model.
	AssetModelTypes []types.AssetModelType

	// The version alias that specifies the latest or active version of the asset
	// model. The details are returned in the response. The default value is LATEST .
	// See [Asset model versions]in the IoT SiteWise User Guide.
	//
	// [Asset model versions]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html
	AssetModelVersion *string

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

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

type ListAssetModelsPaginator added in v0.30.0 

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

ListAssetModelsPaginator is a paginator for ListAssetModels

func NewListAssetModelsPaginator added in v0.30.0 

func NewListAssetModelsPaginator(client ListAssetModelsAPIClient, params *ListAssetModelsInput, optFns ...func(*ListAssetModelsPaginatorOptions)) *ListAssetModelsPaginator

NewListAssetModelsPaginator returns a new ListAssetModelsPaginator

func (*ListAssetModelsPaginator) HasMorePages added in v0.30.0 

func (p *ListAssetModelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssetModelsPaginator) NextPage added in v0.30.0 

func (p *ListAssetModelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssetModelsOutput, error)

NextPage retrieves the next ListAssetModels page.

type ListAssetModelsPaginatorOptions added in v0.30.0 

type ListAssetModelsPaginatorOptions struct {
	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAssetModelsPaginatorOptions is the paginator options for ListAssetModels

type ListAssetPropertiesAPIClient added in v1.26.0 

type ListAssetPropertiesAPIClient interface {
	ListAssetProperties(context.Context, *ListAssetPropertiesInput, ...func(*Options)) (*ListAssetPropertiesOutput, error)
}

ListAssetPropertiesAPIClient is a client that implements the ListAssetProperties operation.

type ListAssetPropertiesInput added in v1.26.0 

type ListAssetPropertiesInput struct {

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

	//  Filters the requested list of asset properties. You can choose one of the
	// following options:
	//
	//   - ALL – The list includes all asset properties for a given asset model ID.
	//
	//   - BASE – The list includes only base asset properties for a given asset model
	//   ID.
	//
	// Default: BASE
	Filter types.ListAssetPropertiesFilter

	// The maximum number of results to return for each paginated request. If not
	// specified, the default value is 50.
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAssetPropertiesOutput added in v1.26.0 

type ListAssetPropertiesOutput struct {

	// A list that summarizes the properties associated with the specified asset.
	//
	// This member is required.
	AssetPropertySummaries []types.AssetPropertySummary

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

type ListAssetPropertiesPaginator added in v1.26.0 

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

ListAssetPropertiesPaginator is a paginator for ListAssetProperties

func NewListAssetPropertiesPaginator added in v1.26.0 

func NewListAssetPropertiesPaginator(client ListAssetPropertiesAPIClient, params *ListAssetPropertiesInput, optFns ...func(*ListAssetPropertiesPaginatorOptions)) *ListAssetPropertiesPaginator

NewListAssetPropertiesPaginator returns a new ListAssetPropertiesPaginator

func (*ListAssetPropertiesPaginator) HasMorePages added in v1.26.0 

func (p *ListAssetPropertiesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssetPropertiesPaginator) NextPage added in v1.26.0 

func (p *ListAssetPropertiesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssetPropertiesOutput, error)

NextPage retrieves the next ListAssetProperties page.

type ListAssetPropertiesPaginatorOptions added in v1.26.0 

type ListAssetPropertiesPaginatorOptions struct {
	// The maximum number of results to return for each paginated request. If not
	// specified, the default value is 50.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAssetPropertiesPaginatorOptions is the paginator options for ListAssetProperties

type ListAssetRelationshipsAPIClient added in v0.31.0 

type ListAssetRelationshipsAPIClient interface {
	ListAssetRelationships(context.Context, *ListAssetRelationshipsInput, ...func(*Options)) (*ListAssetRelationshipsOutput, error)
}

ListAssetRelationshipsAPIClient is a client that implements the ListAssetRelationships operation.

type ListAssetRelationshipsInput added in v0.31.0 

type ListAssetRelationshipsInput struct {

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

	// The type of traversal to use to identify asset relationships. Choose the
	// following option:
	//
	//   - PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The
	//   asset that you specify in assetId is the first result in the list of
	//   assetRelationshipSummaries , and the root asset is the last result.
	//
	// This member is required.
	TraversalType types.TraversalType

	// The maximum number of results to return for each paginated request.
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAssetRelationshipsOutput added in v0.31.0 

type ListAssetRelationshipsOutput struct {

	// A list that summarizes each asset relationship.
	//
	// This member is required.
	AssetRelationshipSummaries []types.AssetRelationshipSummary

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

type ListAssetRelationshipsPaginator added in v0.31.0 

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

ListAssetRelationshipsPaginator is a paginator for ListAssetRelationships

func NewListAssetRelationshipsPaginator added in v0.31.0 

func NewListAssetRelationshipsPaginator(client ListAssetRelationshipsAPIClient, params *ListAssetRelationshipsInput, optFns ...func(*ListAssetRelationshipsPaginatorOptions)) *ListAssetRelationshipsPaginator

NewListAssetRelationshipsPaginator returns a new ListAssetRelationshipsPaginator

func (*ListAssetRelationshipsPaginator) HasMorePages added in v0.31.0 

func (p *ListAssetRelationshipsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssetRelationshipsPaginator) NextPage added in v0.31.0 

func (p *ListAssetRelationshipsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssetRelationshipsOutput, error)

NextPage retrieves the next ListAssetRelationships page.

type ListAssetRelationshipsPaginatorOptions added in v0.31.0 

type ListAssetRelationshipsPaginatorOptions struct {
	// The maximum number of results to return for each paginated request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAssetRelationshipsPaginatorOptions is the paginator options for ListAssetRelationships

type ListAssetsAPIClient added in v0.30.0 

type ListAssetsAPIClient interface {
	ListAssets(context.Context, *ListAssetsInput, ...func(*Options)) (*ListAssetsOutput, error)
}

ListAssetsAPIClient is a client that implements the ListAssets operation.

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

	// The filter for the requested list of assets. Choose one of the following
	// options:
	//
	//   - 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.
	//
	// Default: ALL
	Filter types.ListAssetsFilter

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

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

type ListAssetsPaginator added in v0.30.0 

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

ListAssetsPaginator is a paginator for ListAssets

func NewListAssetsPaginator added in v0.30.0 

func NewListAssetsPaginator(client ListAssetsAPIClient, params *ListAssetsInput, optFns ...func(*ListAssetsPaginatorOptions)) *ListAssetsPaginator

NewListAssetsPaginator returns a new ListAssetsPaginator

func (*ListAssetsPaginator) HasMorePages added in v0.30.0 

func (p *ListAssetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssetsPaginator) NextPage added in v0.30.0 

func (p *ListAssetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssetsOutput, error)

NextPage retrieves the next ListAssets page.

type ListAssetsPaginatorOptions added in v0.30.0 

type ListAssetsPaginatorOptions struct {
	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAssetsPaginatorOptions is the paginator options for ListAssets

type ListAssociatedAssetsAPIClient added in v0.30.0 

type ListAssociatedAssetsAPIClient interface {
	ListAssociatedAssets(context.Context, *ListAssociatedAssetsInput, ...func(*Options)) (*ListAssociatedAssetsOutput, error)
}

ListAssociatedAssetsAPIClient is a client that implements the ListAssociatedAssets operation.

type ListAssociatedAssetsInput 

type ListAssociatedAssetsInput struct {

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

	// (Optional) If you don't provide a hierarchyId , all the immediate assets in the
	// traversalDirection will be returned.
	//
	// The ID of the hierarchy by which child assets are associated to the asset.
	// (This can be either the actual ID in UUID format, or else externalId: followed
	// by the external ID, if it has one. For more information, see [Referencing objects with external IDs]in the IoT
	// SiteWise User Guide.)
	//
	// For more information, see [Asset hierarchies] in the IoT SiteWise User Guide.
	//
	// [Asset hierarchies]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	HierarchyId *string

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string

	// The direction to list associated assets. Choose one of the following options:
	//
	//   - CHILD – The list includes all child assets associated to the asset.
	//
	//   - PARENT – The list includes the asset's parent asset.
	//
	// Default: CHILD
	TraversalDirection types.TraversalDirection
	// contains filtered or unexported fields
}

type ListAssociatedAssetsOutput 

type ListAssociatedAssetsOutput struct {

	// A list that summarizes the associated assets.
	//
	// This member is required.
	AssetSummaries []types.AssociatedAssetsSummary

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

type ListAssociatedAssetsPaginator added in v0.30.0 

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

ListAssociatedAssetsPaginator is a paginator for ListAssociatedAssets

func NewListAssociatedAssetsPaginator added in v0.30.0 

func NewListAssociatedAssetsPaginator(client ListAssociatedAssetsAPIClient, params *ListAssociatedAssetsInput, optFns ...func(*ListAssociatedAssetsPaginatorOptions)) *ListAssociatedAssetsPaginator

NewListAssociatedAssetsPaginator returns a new ListAssociatedAssetsPaginator

func (*ListAssociatedAssetsPaginator) HasMorePages added in v0.30.0 

func (p *ListAssociatedAssetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssociatedAssetsPaginator) NextPage added in v0.30.0 

func (p *ListAssociatedAssetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssociatedAssetsOutput, error)

NextPage retrieves the next ListAssociatedAssets page.

type ListAssociatedAssetsPaginatorOptions added in v0.30.0 

type ListAssociatedAssetsPaginatorOptions struct {
	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAssociatedAssetsPaginatorOptions is the paginator options for ListAssociatedAssets

type ListBulkImportJobsAPIClient added in v1.23.0 

type ListBulkImportJobsAPIClient interface {
	ListBulkImportJobs(context.Context, *ListBulkImportJobsInput, ...func(*Options)) (*ListBulkImportJobsOutput, error)
}

ListBulkImportJobsAPIClient is a client that implements the ListBulkImportJobs operation.

type ListBulkImportJobsInput added in v1.23.0 

type ListBulkImportJobsInput struct {

	// You can use a filter to select the bulk import jobs that you want to retrieve.
	Filter types.ListBulkImportJobsFilter

	// The maximum number of results to return for each paginated request.
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListBulkImportJobsOutput added in v1.23.0 

type ListBulkImportJobsOutput struct {

	// One or more job summaries to list.
	//
	// This member is required.
	JobSummaries []types.JobSummary

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

type ListBulkImportJobsPaginator added in v1.23.0 

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

ListBulkImportJobsPaginator is a paginator for ListBulkImportJobs

func NewListBulkImportJobsPaginator added in v1.23.0 

func NewListBulkImportJobsPaginator(client ListBulkImportJobsAPIClient, params *ListBulkImportJobsInput, optFns ...func(*ListBulkImportJobsPaginatorOptions)) *ListBulkImportJobsPaginator

NewListBulkImportJobsPaginator returns a new ListBulkImportJobsPaginator

func (*ListBulkImportJobsPaginator) HasMorePages added in v1.23.0 

func (p *ListBulkImportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListBulkImportJobsPaginator) NextPage added in v1.23.0 

func (p *ListBulkImportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBulkImportJobsOutput, error)

NextPage retrieves the next ListBulkImportJobs page.

type ListBulkImportJobsPaginatorOptions added in v1.23.0 

type ListBulkImportJobsPaginatorOptions struct {
	// The maximum number of results to return for each paginated request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListBulkImportJobsPaginatorOptions is the paginator options for ListBulkImportJobs

type ListCompositionRelationshipsAPIClient added in v1.33.0 

type ListCompositionRelationshipsAPIClient interface {
	ListCompositionRelationships(context.Context, *ListCompositionRelationshipsInput, ...func(*Options)) (*ListCompositionRelationshipsOutput, error)
}

ListCompositionRelationshipsAPIClient is a client that implements the ListCompositionRelationships operation.

type ListCompositionRelationshipsInput added in v1.33.0 

type ListCompositionRelationshipsInput struct {

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

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCompositionRelationshipsOutput added in v1.33.0 

type ListCompositionRelationshipsOutput struct {

	// A list that summarizes each composition relationship.
	//
	// This member is required.
	CompositionRelationshipSummaries []types.CompositionRelationshipSummary

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

type ListCompositionRelationshipsPaginator added in v1.33.0 

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

ListCompositionRelationshipsPaginator is a paginator for ListCompositionRelationships

func NewListCompositionRelationshipsPaginator added in v1.33.0 

func NewListCompositionRelationshipsPaginator(client ListCompositionRelationshipsAPIClient, params *ListCompositionRelationshipsInput, optFns ...func(*ListCompositionRelationshipsPaginatorOptions)) *ListCompositionRelationshipsPaginator

NewListCompositionRelationshipsPaginator returns a new ListCompositionRelationshipsPaginator

func (*ListCompositionRelationshipsPaginator) HasMorePages added in v1.33.0 

func (p *ListCompositionRelationshipsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCompositionRelationshipsPaginator) NextPage added in v1.33.0 

func (p *ListCompositionRelationshipsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCompositionRelationshipsOutput, error)

NextPage retrieves the next ListCompositionRelationships page.

type ListCompositionRelationshipsPaginatorOptions added in v1.33.0 

type ListCompositionRelationshipsPaginatorOptions struct {
	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCompositionRelationshipsPaginatorOptions is the paginator options for ListCompositionRelationships

type ListDashboardsAPIClient added in v0.30.0 

type ListDashboardsAPIClient interface {
	ListDashboards(context.Context, *ListDashboardsInput, ...func(*Options)) (*ListDashboardsOutput, error)
}

ListDashboardsAPIClient is a client that implements the ListDashboards operation.

type ListDashboardsInput 

type ListDashboardsInput struct {

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

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDashboardsOutput 

type ListDashboardsOutput struct {

	// A list that summarizes each dashboard in the project.
	//
	// This member is required.
	DashboardSummaries []types.DashboardSummary

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

type ListDashboardsPaginator added in v0.30.0 

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

ListDashboardsPaginator is a paginator for ListDashboards

func NewListDashboardsPaginator added in v0.30.0 

func NewListDashboardsPaginator(client ListDashboardsAPIClient, params *ListDashboardsInput, optFns ...func(*ListDashboardsPaginatorOptions)) *ListDashboardsPaginator

NewListDashboardsPaginator returns a new ListDashboardsPaginator

func (*ListDashboardsPaginator) HasMorePages added in v0.30.0 

func (p *ListDashboardsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDashboardsPaginator) NextPage added in v0.30.0 

func (p *ListDashboardsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDashboardsOutput, error)

NextPage retrieves the next ListDashboards page.

type ListDashboardsPaginatorOptions added in v0.30.0 

type ListDashboardsPaginatorOptions struct {
	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDashboardsPaginatorOptions is the paginator options for ListDashboards

type ListGatewaysAPIClient added in v0.30.0 

type ListGatewaysAPIClient interface {
	ListGateways(context.Context, *ListGatewaysInput, ...func(*Options)) (*ListGatewaysOutput, error)
}

ListGatewaysAPIClient is a client that implements the ListGateways operation.

type ListGatewaysInput 

type ListGatewaysInput struct {

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

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

type ListGatewaysPaginator added in v0.30.0 

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

ListGatewaysPaginator is a paginator for ListGateways

func NewListGatewaysPaginator added in v0.30.0 

func NewListGatewaysPaginator(client ListGatewaysAPIClient, params *ListGatewaysInput, optFns ...func(*ListGatewaysPaginatorOptions)) *ListGatewaysPaginator

NewListGatewaysPaginator returns a new ListGatewaysPaginator

func (*ListGatewaysPaginator) HasMorePages added in v0.30.0 

func (p *ListGatewaysPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGatewaysPaginator) NextPage added in v0.30.0 

func (p *ListGatewaysPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGatewaysOutput, error)

NextPage retrieves the next ListGateways page.

type ListGatewaysPaginatorOptions added in v0.30.0 

type ListGatewaysPaginatorOptions struct {
	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListGatewaysPaginatorOptions is the paginator options for ListGateways

type ListPortalsAPIClient added in v0.30.0 

type ListPortalsAPIClient interface {
	ListPortals(context.Context, *ListPortalsInput, ...func(*Options)) (*ListPortalsOutput, error)
}

ListPortalsAPIClient is a client that implements the ListPortals operation.

type ListPortalsInput 

type ListPortalsInput struct {

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

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

type ListPortalsPaginator added in v0.30.0 

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

ListPortalsPaginator is a paginator for ListPortals

func NewListPortalsPaginator added in v0.30.0 

func NewListPortalsPaginator(client ListPortalsAPIClient, params *ListPortalsInput, optFns ...func(*ListPortalsPaginatorOptions)) *ListPortalsPaginator

NewListPortalsPaginator returns a new ListPortalsPaginator

func (*ListPortalsPaginator) HasMorePages added in v0.30.0 

func (p *ListPortalsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPortalsPaginator) NextPage added in v0.30.0 

func (p *ListPortalsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPortalsOutput, error)

NextPage retrieves the next ListPortals page.

type ListPortalsPaginatorOptions added in v0.30.0 

type ListPortalsPaginatorOptions struct {
	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPortalsPaginatorOptions is the paginator options for ListPortals

type ListProjectAssetsAPIClient added in v0.30.0 

type ListProjectAssetsAPIClient interface {
	ListProjectAssets(context.Context, *ListProjectAssetsInput, ...func(*Options)) (*ListProjectAssetsOutput, error)
}

ListProjectAssetsAPIClient is a client that implements the ListProjectAssets operation.

type ListProjectAssetsInput 

type ListProjectAssetsInput struct {

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

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListProjectAssetsOutput 

type ListProjectAssetsOutput struct {

	// A list that contains the IDs of each asset associated with the project.
	//
	// This member is required.
	AssetIds []string

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

type ListProjectAssetsPaginator added in v0.30.0 

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

ListProjectAssetsPaginator is a paginator for ListProjectAssets

func NewListProjectAssetsPaginator added in v0.30.0 

func NewListProjectAssetsPaginator(client ListProjectAssetsAPIClient, params *ListProjectAssetsInput, optFns ...func(*ListProjectAssetsPaginatorOptions)) *ListProjectAssetsPaginator

NewListProjectAssetsPaginator returns a new ListProjectAssetsPaginator

func (*ListProjectAssetsPaginator) HasMorePages added in v0.30.0 

func (p *ListProjectAssetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProjectAssetsPaginator) NextPage added in v0.30.0 

func (p *ListProjectAssetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProjectAssetsOutput, error)

NextPage retrieves the next ListProjectAssets page.

type ListProjectAssetsPaginatorOptions added in v0.30.0 

type ListProjectAssetsPaginatorOptions struct {
	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListProjectAssetsPaginatorOptions is the paginator options for ListProjectAssets

type ListProjectsAPIClient added in v0.30.0 

type ListProjectsAPIClient interface {
	ListProjects(context.Context, *ListProjectsInput, ...func(*Options)) (*ListProjectsOutput, error)
}

ListProjectsAPIClient is a client that implements the ListProjects operation.

type ListProjectsInput 

type ListProjectsInput struct {

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

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListProjectsOutput 

type ListProjectsOutput struct {

	// A list that summarizes each project in the portal.
	//
	// This member is required.
	ProjectSummaries []types.ProjectSummary

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

type ListProjectsPaginator added in v0.30.0 

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

ListProjectsPaginator is a paginator for ListProjects

func NewListProjectsPaginator added in v0.30.0 

func NewListProjectsPaginator(client ListProjectsAPIClient, params *ListProjectsInput, optFns ...func(*ListProjectsPaginatorOptions)) *ListProjectsPaginator

NewListProjectsPaginator returns a new ListProjectsPaginator

func (*ListProjectsPaginator) HasMorePages added in v0.30.0 

func (p *ListProjectsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProjectsPaginator) NextPage added in v0.30.0 

func (p *ListProjectsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProjectsOutput, error)

NextPage retrieves the next ListProjects page.

type ListProjectsPaginatorOptions added in v0.30.0 

type ListProjectsPaginatorOptions struct {
	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListProjectsPaginatorOptions is the paginator options for ListProjects

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The [ARN] of the resource.
	//
	// [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The list of key-value pairs that contain metadata for the resource. For more
	// information, see [Tagging your IoT SiteWise resources]in the IoT SiteWise User Guide.
	//
	// [Tagging your IoT SiteWise resources]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTimeSeriesAPIClient added in v1.15.0 

type ListTimeSeriesAPIClient interface {
	ListTimeSeries(context.Context, *ListTimeSeriesInput, ...func(*Options)) (*ListTimeSeriesOutput, error)
}

ListTimeSeriesAPIClient is a client that implements the ListTimeSeries operation.

type ListTimeSeriesInput added in v1.15.0 

type ListTimeSeriesInput struct {

	// The alias prefix of the time series.
	AliasPrefix *string

	// The ID of the asset in which the asset property was created. This can be either
	// the actual ID in UUID format, or else externalId: followed by the external ID,
	// if it has one. For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.
	//
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	AssetId *string

	// The maximum number of results to return for each paginated request.
	MaxResults *int32

	// The token to be used for the next set of paginated results.
	NextToken *string

	// The type of the time series. The time series type can be one of the following
	// values:
	//
	//   - ASSOCIATED – The time series is associated with an asset property.
	//
	//   - DISASSOCIATED – The time series isn't associated with any asset property.
	TimeSeriesType types.ListTimeSeriesType
	// contains filtered or unexported fields
}

type ListTimeSeriesOutput added in v1.15.0 

type ListTimeSeriesOutput struct {

	// One or more time series summaries to list.
	//
	// This member is required.
	TimeSeriesSummaries []types.TimeSeriesSummary

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

type ListTimeSeriesPaginator added in v1.15.0 

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

ListTimeSeriesPaginator is a paginator for ListTimeSeries

func NewListTimeSeriesPaginator added in v1.15.0 

func NewListTimeSeriesPaginator(client ListTimeSeriesAPIClient, params *ListTimeSeriesInput, optFns ...func(*ListTimeSeriesPaginatorOptions)) *ListTimeSeriesPaginator

NewListTimeSeriesPaginator returns a new ListTimeSeriesPaginator

func (*ListTimeSeriesPaginator) HasMorePages added in v1.15.0 

func (p *ListTimeSeriesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTimeSeriesPaginator) NextPage added in v1.15.0 

func (p *ListTimeSeriesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTimeSeriesOutput, error)

NextPage retrieves the next ListTimeSeries page.

type ListTimeSeriesPaginatorOptions added in v1.15.0 

type ListTimeSeriesPaginatorOptions struct {
	// The maximum number of results to return for each paginated request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTimeSeriesPaginatorOptions is the paginator options for ListTimeSeries

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 optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.32.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PortalActiveWaiter added in v0.31.0 

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

PortalActiveWaiter defines the waiters for PortalActive

func NewPortalActiveWaiter added in v0.31.0 

func NewPortalActiveWaiter(client DescribePortalAPIClient, optFns ...func(*PortalActiveWaiterOptions)) *PortalActiveWaiter

NewPortalActiveWaiter constructs a PortalActiveWaiter.

func (*PortalActiveWaiter) Wait added in v0.31.0 

func (w *PortalActiveWaiter) Wait(ctx context.Context, params *DescribePortalInput, maxWaitDur time.Duration, optFns ...func(*PortalActiveWaiterOptions)) error

Wait calls the waiter function for PortalActive waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*PortalActiveWaiter) WaitForOutput added in v1.14.0 

func (w *PortalActiveWaiter) WaitForOutput(ctx context.Context, params *DescribePortalInput, maxWaitDur time.Duration, optFns ...func(*PortalActiveWaiterOptions)) (*DescribePortalOutput, error)

WaitForOutput calls the waiter function for PortalActive waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type PortalActiveWaiterOptions added in v0.31.0 

type PortalActiveWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// PortalActiveWaiter will use default minimum delay of 3 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, PortalActiveWaiter will use default max delay of 120 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribePortalInput, *DescribePortalOutput, error) (bool, error)
}

PortalActiveWaiterOptions are waiter options for PortalActiveWaiter

type PortalNotExistsWaiter added in v0.31.0 

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

PortalNotExistsWaiter defines the waiters for PortalNotExists

func NewPortalNotExistsWaiter added in v0.31.0 

func NewPortalNotExistsWaiter(client DescribePortalAPIClient, optFns ...func(*PortalNotExistsWaiterOptions)) *PortalNotExistsWaiter

NewPortalNotExistsWaiter constructs a PortalNotExistsWaiter.

func (*PortalNotExistsWaiter) Wait added in v0.31.0 

func (w *PortalNotExistsWaiter) Wait(ctx context.Context, params *DescribePortalInput, maxWaitDur time.Duration, optFns ...func(*PortalNotExistsWaiterOptions)) error

Wait calls the waiter function for PortalNotExists waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*PortalNotExistsWaiter) WaitForOutput added in v1.14.0 

func (w *PortalNotExistsWaiter) WaitForOutput(ctx context.Context, params *DescribePortalInput, maxWaitDur time.Duration, optFns ...func(*PortalNotExistsWaiterOptions)) (*DescribePortalOutput, error)

WaitForOutput calls the waiter function for PortalNotExists waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type PortalNotExistsWaiterOptions added in v0.31.0 

type PortalNotExistsWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// PortalNotExistsWaiter will use default minimum delay of 3 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, PortalNotExistsWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribePortalInput, *DescribePortalOutput, error) (bool, error)
}

PortalNotExistsWaiterOptions are waiter options for PortalNotExistsWaiter

type PutDefaultEncryptionConfigurationInput added in v0.31.0 

type PutDefaultEncryptionConfigurationInput struct {

	// The type of encryption used for the encryption configuration.
	//
	// This member is required.
	EncryptionType types.EncryptionType

	// The Key ID of the customer managed key used for KMS encryption. This is
	// required if you use KMS_BASED_ENCRYPTION .
	KmsKeyId *string
	// contains filtered or unexported fields
}

type PutDefaultEncryptionConfigurationOutput added in v0.31.0 

type PutDefaultEncryptionConfigurationOutput struct {

	// The status of the account configuration. This contains the ConfigurationState .
	// If there is an error, it also contains the ErrorDetails .
	//
	// This member is required.
	ConfigurationStatus *types.ConfigurationStatus

	// The type of encryption used for the encryption configuration.
	//
	// This member is required.
	EncryptionType types.EncryptionType

	// The Key ARN of the KMS key used for KMS encryption if you use
	// KMS_BASED_ENCRYPTION .
	KmsKeyArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutLoggingOptionsInput 

type PutLoggingOptionsInput struct {

	// The logging options to set.
	//
	// This member is required.
	LoggingOptions *types.LoggingOptions
	// contains filtered or unexported fields
}

type PutLoggingOptionsOutput 

type PutLoggingOptionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutStorageConfigurationInput added in v1.8.0 

type PutStorageConfigurationInput struct {

	// The storage tier that you specified for your data. The storageType parameter
	// can be one of the following values:
	//
	//   - SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier.
	//   The hot tier is a service-managed database.
	//
	//   - MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and
	//   the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
	//
	// This member is required.
	StorageType types.StorageType

	// Contains the storage configuration for time series (data streams) that aren't
	// associated with asset properties. The disassociatedDataStorage can be one of
	// the following values:
	//
	//   - ENABLED – IoT SiteWise accepts time series that aren't associated with asset
	//   properties.
	//
	// After the disassociatedDataStorage is enabled, you can't disable it.
	//
	//   - DISABLED – IoT SiteWise doesn't accept time series (data streams) that
	//   aren't associated with asset properties.
	//
	// For more information, see [Data streams] in the IoT SiteWise User Guide.
	//
	// [Data streams]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html
	DisassociatedDataStorage types.DisassociatedDataStorageState

	// Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the
	// storage type, you must specify a MultiLayerStorage object.
	MultiLayerStorage *types.MultiLayerStorage

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

	// A service managed storage tier optimized for analytical queries. It stores
	// periodically uploaded, buffered and historical data ingested with the
	// CreaeBulkImportJob API.
	WarmTier types.WarmTierState

	// Set this period to specify how long your data is stored in the warm tier before
	// it is deleted. You can set this only if cold tier is enabled.
	WarmTierRetentionPeriod *types.WarmTierRetentionPeriod
	// contains filtered or unexported fields
}

type PutStorageConfigurationOutput added in v1.8.0 

type PutStorageConfigurationOutput struct {

	// Contains current status information for the configuration.
	//
	// This member is required.
	ConfigurationStatus *types.ConfigurationStatus

	// The storage tier that you specified for your data. The storageType parameter
	// can be one of the following values:
	//
	//   - SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier.
	//   The hot tier is a service-managed database.
	//
	//   - MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and
	//   the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
	//
	// This member is required.
	StorageType types.StorageType

	// Contains the storage configuration for time series (data streams) that aren't
	// associated with asset properties. The disassociatedDataStorage can be one of
	// the following values:
	//
	//   - ENABLED – IoT SiteWise accepts time series that aren't associated with asset
	//   properties.
	//
	// After the disassociatedDataStorage is enabled, you can't disable it.
	//
	//   - DISABLED – IoT SiteWise doesn't accept time series (data streams) that
	//   aren't associated with asset properties.
	//
	// For more information, see [Data streams] in the IoT SiteWise User Guide.
	//
	// [Data streams]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html
	DisassociatedDataStorage types.DisassociatedDataStorageState

	// Contains information about the storage destination.
	MultiLayerStorage *types.MultiLayerStorage

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

	// A service managed storage tier optimized for analytical queries. It stores
	// periodically uploaded, buffered and historical data ingested with the
	// CreaeBulkImportJob API.
	WarmTier types.WarmTierState

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

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 TagResourceInput 

type TagResourceInput struct {

	// The [ARN] of the resource to tag.
	//
	// [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	ResourceArn *string

	// A list of key-value pairs that contain metadata for the resource. For more
	// information, see [Tagging your IoT SiteWise resources]in the IoT SiteWise User Guide.
	//
	// [Tagging your IoT SiteWise resources]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The [ARN] of the resource to untag.
	//
	// [ARN]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
	//
	// This member is required.
	ResourceArn *string

	// A list of keys for tags to remove from the resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAccessPolicyInput 

type UpdateAccessPolicyInput struct {

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

	// The identity for this access policy. Choose an IAM Identity Center user, an IAM
	// Identity Center group, or an IAM user.
	//
	// This member is required.
	AccessPolicyIdentity *types.Identity

	// 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

	// The IoT SiteWise Monitor resource for this access policy. Choose either a
	// portal or a project.
	//
	// This member is required.
	AccessPolicyResource *types.Resource

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

type UpdateAccessPolicyOutput 

type UpdateAccessPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAssetInput 

type UpdateAssetInput struct {

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

	// A friendly name for the asset.
	//
	// This member is required.
	AssetName *string

	// A description for the asset.
	AssetDescription *string

	// An external ID to assign to the asset. The asset must not already have an
	// external ID. The external ID must be unique within your Amazon Web Services
	// account. For more information, see [Using external IDs]in the IoT SiteWise User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	AssetExternalId *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
	// contains filtered or unexported fields
}

type UpdateAssetModelCompositeModelInput added in v1.33.0 

type UpdateAssetModelCompositeModelInput struct {

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

	// A unique name for the composite model.
	//
	// This member is required.
	AssetModelCompositeModelName *string

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

	// A description for the composite model.
	AssetModelCompositeModelDescription *string

	// An external ID to assign to the asset model. You can only set the external ID
	// of the asset model if it wasn't set when it was created, or you're setting it to
	// the exact same thing as when it was created.
	AssetModelCompositeModelExternalId *string

	// The property definitions of the composite model. For more information, see [Inline custom composite models] in
	// the IoT SiteWise User Guide.
	//
	// You can specify up to 200 properties per composite model. For more information,
	// see [Quotas]in the IoT SiteWise User Guide.
	//
	// [Inline custom composite models]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models
	// [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
	AssetModelCompositeModelProperties []types.AssetModelProperty

	// 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 expected current entity tag (ETag) for the asset model’s latest or active
	// version (specified using matchForVersionType ). The update request is rejected
	// if the tag does not match the latest or active version's current entity tag. See
	// [Optimistic locking for asset model writes]in the IoT SiteWise User Guide.
	//
	// [Optimistic locking for asset model writes]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
	IfMatch *string

	// Accepts * to reject the update request if an active version (specified using
	// matchForVersionType as ACTIVE ) already exists for the asset model.
	IfNoneMatch *string

	// Specifies the asset model version type ( LATEST or ACTIVE ) used in conjunction
	// with If-Match or If-None-Match headers to determine the target ETag for the
	// update operation.
	MatchForVersionType types.AssetModelVersionType
	// contains filtered or unexported fields
}

type UpdateAssetModelCompositeModelOutput added in v1.33.0 

type UpdateAssetModelCompositeModelOutput struct {

	// The path to the composite model listing the parent composite models.
	//
	// This member is required.
	AssetModelCompositeModelPath []types.AssetModelCompositeModelPathSegment

	// Contains current status information for an asset model. For more information,
	// see [Asset and model states]in the IoT SiteWise User Guide.
	//
	// [Asset and model states]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html
	//
	// This member is required.
	AssetModelStatus *types.AssetModelStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAssetModelInput 

type UpdateAssetModelInput struct {

	// The ID of the asset model to update. This can be either the actual ID in UUID
	// format, or else externalId: followed by the external ID, if it has one. For
	// more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.
	//
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	//
	// This member is required.
	AssetModelId *string

	// A unique name for the asset model.
	//
	// This member is required.
	AssetModelName *string

	// The composite models that are part of this asset model. It groups properties
	// (such as attributes, measurements, transforms, and metrics) and child composite
	// models that model parts of your industrial equipment. Each composite model has a
	// type that defines the properties that the composite model supports. Use
	// composite models to define alarms on this asset model.
	//
	// When creating custom composite models, you need to use [CreateAssetModelCompositeModel]. For more information,
	// see [Creating custom composite models (Components)]in the IoT SiteWise User Guide.
	//
	// [CreateAssetModelCompositeModel]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html
	// [Creating custom composite models (Components)]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html
	AssetModelCompositeModels []types.AssetModelCompositeModel

	// A description for the asset model.
	AssetModelDescription *string

	// An external ID to assign to the asset model. The asset model must not already
	// have an external ID. The external ID must be unique within your Amazon Web
	// Services account. For more information, see [Using external IDs]in the IoT SiteWise User Guide.
	//
	// [Using external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids
	AssetModelExternalId *string

	// The updated hierarchy definitions of the asset model. Each hierarchy specifies
	// an asset model whose assets can be children of any other assets created from
	// this asset model. For more information, see [Asset hierarchies]in the IoT SiteWise User Guide.
	//
	// You can specify up to 10 hierarchies per asset model. For more information, see [Quotas]
	// in the IoT SiteWise User Guide.
	//
	// [Asset hierarchies]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
	// [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
	AssetModelHierarchies []types.AssetModelHierarchy

	// The updated property definitions of the asset model. For more information, see [Asset properties]
	// in the IoT SiteWise User Guide.
	//
	// You can specify up to 200 properties per asset model. For more information, see [Quotas]
	// in the IoT SiteWise User Guide.
	//
	// [Asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html
	// [Quotas]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html
	AssetModelProperties []types.AssetModelProperty

	// 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 expected current entity tag (ETag) for the asset model’s latest or active
	// version (specified using matchForVersionType ). The update request is rejected
	// if the tag does not match the latest or active version's current entity tag. See
	// [Optimistic locking for asset model writes]in the IoT SiteWise User Guide.
	//
	// [Optimistic locking for asset model writes]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html
	IfMatch *string

	// Accepts * to reject the update request if an active version (specified using
	// matchForVersionType as ACTIVE ) already exists for the asset model.
	IfNoneMatch *string

	// Specifies the asset model version type ( LATEST or ACTIVE ) used in conjunction
	// with If-Match or If-None-Match headers to determine the target ETag for the
	// update operation.
	MatchForVersionType types.AssetModelVersionType
	// contains filtered or unexported fields
}

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

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

type UpdateAssetPropertyInput 

type UpdateAssetPropertyInput struct {

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

	// The ID of the asset property to be updated. This can be either the actual ID in
	// UUID format, or else externalId: followed by the external ID, if it has one.
	// For more information, see [Referencing objects with external IDs]in the IoT SiteWise User Guide.
	//
	// [Referencing objects with external IDs]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references
	//
	// This member is required.
	PropertyId *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 alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature ). For more
	// information, see [Mapping industrial data streams to asset properties]in the IoT SiteWise User Guide.
	//
	// If you omit this parameter, the alias is removed from the property.
	//
	// [Mapping industrial data streams to asset properties]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
	PropertyAlias *string

	// The MQTT notification state (enabled or disabled) for this asset property. When
	// the notification state is enabled, IoT SiteWise publishes property value updates
	// to a unique MQTT topic. For more information, see [Interacting with other services]in the IoT SiteWise User
	// Guide.
	//
	// If you omit this parameter, the notification state is set to DISABLED .
	//
	// [Interacting with other services]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html
	PropertyNotificationState types.PropertyNotificationState

	// The unit of measure (such as Newtons or RPM) of the asset property. If you
	// don't specify a value for this parameter, the service uses the value of the
	// assetModelProperty in the asset model.
	PropertyUnit *string
	// contains filtered or unexported fields
}

type UpdateAssetPropertyOutput 

type UpdateAssetPropertyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDashboardInput 

type UpdateDashboardInput struct {

	// The new dashboard definition, as specified in a JSON literal. For detailed
	// information, see [Creating dashboards (CLI)]in the IoT SiteWise User Guide.
	//
	// [Creating dashboards (CLI)]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html
	//
	// This member is required.
	DashboardDefinition *string

	// The ID of the dashboard to update.
	//
	// This member is required.
	DashboardId *string

	// A new friendly name for the dashboard.
	//
	// This member is required.
	DashboardName *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 new description for the dashboard.
	DashboardDescription *string
	// contains filtered or unexported fields
}

type UpdateDashboardOutput 

type UpdateDashboardOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateGatewayCapabilityConfigurationInput 

type UpdateGatewayCapabilityConfigurationInput struct {

	// The JSON document that defines the configuration for the gateway capability.
	// For more information, see [Configuring data sources (CLI)]in the IoT SiteWise User Guide.
	//
	// [Configuring data sources (CLI)]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli
	//
	// This member is required.
	CapabilityConfiguration *string

	// The namespace of the gateway capability configuration to be updated. For
	// example, if you configure OPC-UA sources from the IoT SiteWise console, your
	// OPC-UA capability configuration has the namespace
	// iotsitewise:opcuacollector:version , where version is a number such as 1 .
	//
	// This member is required.
	CapabilityNamespace *string

	// The ID of the gateway to be updated.
	//
	// This member is required.
	GatewayId *string
	// contains filtered or unexported fields
}

type UpdateGatewayCapabilityConfigurationOutput 

type UpdateGatewayCapabilityConfigurationOutput struct {

	// The namespace of the gateway capability.
	//
	// This member is required.
	CapabilityNamespace *string

	// The synchronization status of the capability configuration. The sync status can
	// be one of the following:
	//
	//   - IN_SYNC – The gateway is running the capability configuration.
	//
	//   - OUT_OF_SYNC – The gateway hasn't received the capability configuration.
	//
	//   - SYNC_FAILED – The gateway rejected the capability configuration.
	//
	// 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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateGatewayInput 

type UpdateGatewayInput struct {

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

	// A unique name for the gateway.
	//
	// This member is required.
	GatewayName *string
	// contains filtered or unexported fields
}

type UpdateGatewayOutput 

type UpdateGatewayOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdatePortalInput 

type UpdatePortalInput struct {

	// The Amazon Web Services administrator's contact email address.
	//
	// This member is required.
	PortalContactEmail *string

	// The ID of the portal to update.
	//
	// This member is required.
	PortalId *string

	// A new friendly name for the portal.
	//
	// This member is required.
	PortalName *string

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

	// Contains the configuration information of an alarm created in an IoT SiteWise
	// Monitor portal. You can use the alarm to monitor an asset property and get
	// notified when the asset property value is outside a specified range. For more
	// information, see [Monitoring with alarms]in the IoT SiteWise Application Guide.
	//
	// [Monitoring with alarms]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
	Alarms *types.Alarms

	// 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 email address that sends alarm notifications.
	NotificationSenderEmail *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
	// contains filtered or unexported fields
}

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

type UpdateProjectInput 

type UpdateProjectInput struct {

	// The ID of the project to update.
	//
	// This member is required.
	ProjectId *string

	// A new friendly name for the project.
	//
	// This member is required.
	ProjectName *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 new description for the project.
	ProjectDescription *string
	// contains filtered or unexported fields
}

type UpdateProjectOutput 

type UpdateProjectOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

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