AWS IoT SiteWise 2019-12-02
- Client: Aws\IoTSiteWise\IoTSiteWiseClient
- Service ID: iotsitewise
- Version: 2019-12-02
This page describes the parameters and results for the operations of the AWS IoT SiteWise (2019-12-02), and shows how to use the Aws\IoTSiteWise\IoTSiteWiseClient object to call the described operations. This documentation is specific to the 2019-12-02 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- AssociateAssets ( array $params = [] )
- Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model.
- AssociateTimeSeriesToAssetProperty ( array $params = [] )
- Associates a time series (data stream) with an asset property.
- BatchAssociateProjectAssets ( array $params = [] )
- Associates a group (batch) of assets with an IoT SiteWise Monitor project.
- BatchDisassociateProjectAssets ( array $params = [] )
- Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
- BatchGetAssetPropertyAggregates ( array $params = [] )
- Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties.
- BatchGetAssetPropertyValue ( array $params = [] )
- Gets the current value for one or more asset properties.
- BatchGetAssetPropertyValueHistory ( array $params = [] )
- Gets the historical values for one or more asset properties.
- BatchPutAssetPropertyValue ( array $params = [] )
- Sends a list of asset property values to IoT SiteWise.
- CreateAccessPolicy ( array $params = [] )
- 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.
- CreateAsset ( array $params = [] )
- Creates an asset from an existing asset model.
- CreateAssetModel ( array $params = [] )
- Creates an asset model from specified property and hierarchy definitions.
- CreateAssetModelCompositeModel ( array $params = [] )
- Creates a custom composite model from specified property and hierarchy definitions.
- CreateBulkImportJob ( array $params = [] )
- Defines a job to ingest data to IoT SiteWise from Amazon S3.
- CreateDashboard ( array $params = [] )
- Creates a dashboard in an IoT SiteWise Monitor project.
- CreateDataset ( array $params = [] )
- Creates a dataset to connect an external datasource.
- CreateGateway ( array $params = [] )
- Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise.
- CreatePortal ( array $params = [] )
- Creates a portal, which can contain projects and dashboards.
- CreateProject ( array $params = [] )
- Creates a project in the specified portal.
- DeleteAccessPolicy ( array $params = [] )
- Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource.
- DeleteAsset ( array $params = [] )
- Deletes an asset.
- DeleteAssetModel ( array $params = [] )
- Deletes an asset model.
- DeleteAssetModelCompositeModel ( array $params = [] )
- Deletes a composite model.
- DeleteDashboard ( array $params = [] )
- Deletes a dashboard from IoT SiteWise Monitor.
- DeleteDataset ( array $params = [] )
- Deletes a dataset.
- DeleteGateway ( array $params = [] )
- Deletes a gateway from IoT SiteWise.
- DeletePortal ( array $params = [] )
- Deletes a portal from IoT SiteWise Monitor.
- DeleteProject ( array $params = [] )
- Deletes a project from IoT SiteWise Monitor.
- DeleteTimeSeries ( array $params = [] )
- Deletes a time series (data stream).
- DescribeAccessPolicy ( array $params = [] )
- Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
- DescribeAction ( array $params = [] )
- Retrieves information about an action.
- DescribeAsset ( array $params = [] )
- Retrieves information about an asset.
- DescribeAssetCompositeModel ( array $params = [] )
- Retrieves information about an asset composite model (also known as an asset component).
- DescribeAssetModel ( array $params = [] )
- Retrieves information about an asset model.
- DescribeAssetModelCompositeModel ( array $params = [] )
- Retrieves information about an asset model composite model (also known as an asset model component).
- DescribeAssetProperty ( array $params = [] )
- Retrieves information about an asset property.
- DescribeBulkImportJob ( array $params = [] )
- Retrieves information about a bulk import job request.
- DescribeDashboard ( array $params = [] )
- Retrieves information about a dashboard.
- DescribeDataset ( array $params = [] )
- Retrieves information about a dataset.
- DescribeDefaultEncryptionConfiguration ( array $params = [] )
- Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region.
- DescribeGateway ( array $params = [] )
- Retrieves information about a gateway.
- DescribeGatewayCapabilityConfiguration ( array $params = [] )
- Retrieves information about a gateway capability configuration.
- DescribeLoggingOptions ( array $params = [] )
- Retrieves the current IoT SiteWise logging options.
- DescribePortal ( array $params = [] )
- Retrieves information about a portal.
- DescribeProject ( array $params = [] )
- Retrieves information about a project.
- DescribeStorageConfiguration ( array $params = [] )
- Retrieves information about the storage configuration for IoT SiteWise.
- DescribeTimeSeries ( array $params = [] )
- Retrieves information about a time series (data stream).
- DisassociateAssets ( array $params = [] )
- Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
- DisassociateTimeSeriesFromAssetProperty ( array $params = [] )
- Disassociates a time series (data stream) from an asset property.
- ExecuteAction ( array $params = [] )
- Executes an action on a target resource.
- ExecuteQuery ( array $params = [] )
- Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.
- GetAssetPropertyAggregates ( array $params = [] )
- Gets aggregated values for an asset property.
- GetAssetPropertyValue ( array $params = [] )
- Gets an asset property's current value.
- GetAssetPropertyValueHistory ( array $params = [] )
- Gets the history of an asset property's values.
- GetInterpolatedAssetPropertyValues ( array $params = [] )
- Get interpolated values for an asset property for a specified time interval, during a period of time.
- InvokeAssistant ( array $params = [] )
- Invokes SiteWise Assistant to start or continue a conversation.
- ListAccessPolicies ( array $params = [] )
- 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).
- ListActions ( array $params = [] )
- Retrieves a paginated list of actions for a specific target resource.
- ListAssetModelCompositeModels ( array $params = [] )
- Retrieves a paginated list of composite models associated with the asset model
- ListAssetModelProperties ( array $params = [] )
- Retrieves a paginated list of properties associated with an asset model.
- ListAssetModels ( array $params = [] )
- Retrieves a paginated list of summaries of all asset models.
- ListAssetProperties ( array $params = [] )
- Retrieves a paginated list of properties associated with an asset.
- ListAssetRelationships ( array $params = [] )
- Retrieves a paginated list of asset relationships for an asset.
- ListAssets ( array $params = [] )
- Retrieves a paginated list of asset summaries.
- ListAssociatedAssets ( array $params = [] )
- Retrieves a paginated list of associated assets.
- ListBulkImportJobs ( array $params = [] )
- Retrieves a paginated list of bulk import job requests.
- ListCompositionRelationships ( array $params = [] )
- Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.
- ListDashboards ( array $params = [] )
- Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
- ListDatasets ( array $params = [] )
- Retrieves a paginated list of datasets for a specific target resource.
- ListGateways ( array $params = [] )
- Retrieves a paginated list of gateways.
- ListPortals ( array $params = [] )
- Retrieves a paginated list of IoT SiteWise Monitor portals.
- ListProjectAssets ( array $params = [] )
- Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
- ListProjects ( array $params = [] )
- Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
- ListTagsForResource ( array $params = [] )
- Retrieves the list of tags for an IoT SiteWise resource.
- ListTimeSeries ( array $params = [] )
- Retrieves a paginated list of time series (data streams).
- PutDefaultEncryptionConfiguration ( array $params = [] )
- Sets the default encryption configuration for the Amazon Web Services account.
- PutLoggingOptions ( array $params = [] )
- Sets logging options for IoT SiteWise.
- PutStorageConfiguration ( array $params = [] )
- Configures storage settings for IoT SiteWise.
- TagResource ( array $params = [] )
- Adds tags to an IoT SiteWise resource.
- UntagResource ( array $params = [] )
- Removes a tag from an IoT SiteWise resource.
- UpdateAccessPolicy ( array $params = [] )
- Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
- UpdateAsset ( array $params = [] )
- Updates an asset's name.
- UpdateAssetModel ( array $params = [] )
- Updates an asset model and all of the assets that were created from the model.
- UpdateAssetModelCompositeModel ( array $params = [] )
- Updates a composite model and all of the assets that were created from the model.
- UpdateAssetProperty ( array $params = [] )
- Updates an asset property's alias and notification state.
- UpdateDashboard ( array $params = [] )
- Updates an IoT SiteWise Monitor dashboard.
- UpdateDataset ( array $params = [] )
- Updates a dataset.
- UpdateGateway ( array $params = [] )
- Updates a gateway's name.
- UpdateGatewayCapabilityConfiguration ( array $params = [] )
- Updates a gateway capability configuration or defines a new capability configuration.
- UpdatePortal ( array $params = [] )
- Updates an IoT SiteWise Monitor portal.
- UpdateProject ( array $params = [] )
- Updates an IoT SiteWise Monitor project.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- BatchGetAssetPropertyAggregates
- BatchGetAssetPropertyValue
- BatchGetAssetPropertyValueHistory
- ExecuteQuery
- GetAssetPropertyAggregates
- GetAssetPropertyValueHistory
- GetInterpolatedAssetPropertyValues
- ListAccessPolicies
- ListActions
- ListAssetModelCompositeModels
- ListAssetModelProperties
- ListAssetModels
- ListAssetProperties
- ListAssetRelationships
- ListAssets
- ListAssociatedAssets
- ListBulkImportJobs
- ListCompositionRelationships
- ListDashboards
- ListDatasets
- ListGateways
- ListPortals
- ListProjectAssets
- ListProjects
- ListTimeSeries
Waiters
Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:
Waiter name | API Operation | Delay | Max Attempts |
---|---|---|---|
AssetModelNotExists | DescribeAssetModel | 3 | 20 |
AssetModelActive | DescribeAssetModel | 3 | 20 |
AssetNotExists | DescribeAsset | 3 | 20 |
AssetActive | DescribeAsset | 3 | 20 |
PortalNotExists | DescribePortal | 3 | 20 |
PortalActive | DescribePortal | 3 | 20 |
Operations
AssociateAssets
$result = $client->associateAssets
([/* ... */]); $promise = $client->associateAssetsAsync
([/* ... */]);
Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide.
Parameter Syntax
$result = $client->associateAssets([ 'assetId' => '<string>', // REQUIRED 'childAssetId' => '<string>', // REQUIRED 'clientToken' => '<string>', 'hierarchyId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- assetId
-
- Required: Yes
- Type: string
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. - childAssetId
-
- Required: Yes
- Type: 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. - clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- hierarchyId
-
- Required: Yes
- Type: 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.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceAlreadyExistsException:
The resource already exists.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
AssociateTimeSeriesToAssetProperty
$result = $client->associateTimeSeriesToAssetProperty
([/* ... */]); $promise = $client->associateTimeSeriesToAssetPropertyAsync
([/* ... */]);
Associates a time series (data stream) with an asset property.
Parameter Syntax
$result = $client->associateTimeSeriesToAssetProperty([ 'alias' => '<string>', // REQUIRED 'assetId' => '<string>', // REQUIRED 'clientToken' => '<string>', 'propertyId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- alias
-
- Required: Yes
- Type: string
The alias that identifies the time series.
- assetId
-
- Required: Yes
- Type: 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. - clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- propertyId
-
- Required: Yes
- Type: 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.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
BatchAssociateProjectAssets
$result = $client->batchAssociateProjectAssets
([/* ... */]); $promise = $client->batchAssociateProjectAssetsAsync
([/* ... */]);
Associates a group (batch) of assets with an IoT SiteWise Monitor project.
Parameter Syntax
$result = $client->batchAssociateProjectAssets([ 'assetIds' => ['<string>', ...], // REQUIRED 'clientToken' => '<string>', 'projectId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- assetIds
-
- Required: Yes
- Type: Array of strings
The IDs of the assets to be associated to the project.
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- projectId
-
- Required: Yes
- Type: string
The ID of the project to which to associate the assets.
Result Syntax
[ 'errors' => [ [ 'assetId' => '<string>', 'code' => 'INTERNAL_FAILURE', 'message' => '<string>', ], // ... ], ]
Result Details
Members
- errors
-
- Type: Array of AssetErrorDetails structures
A list of associated error information, if any.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
BatchDisassociateProjectAssets
$result = $client->batchDisassociateProjectAssets
([/* ... */]); $promise = $client->batchDisassociateProjectAssetsAsync
([/* ... */]);
Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
Parameter Syntax
$result = $client->batchDisassociateProjectAssets([ 'assetIds' => ['<string>', ...], // REQUIRED 'clientToken' => '<string>', 'projectId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- assetIds
-
- Required: Yes
- Type: Array of strings
The IDs of the assets to be disassociated from the project.
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- projectId
-
- Required: Yes
- Type: string
The ID of the project from which to disassociate the assets.
Result Syntax
[ 'errors' => [ [ 'assetId' => '<string>', 'code' => 'INTERNAL_FAILURE', 'message' => '<string>', ], // ... ], ]
Result Details
Members
- errors
-
- Type: Array of AssetErrorDetails structures
A list of associated error information, if any.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
BatchGetAssetPropertyAggregates
$result = $client->batchGetAssetPropertyAggregates
([/* ... */]); $promise = $client->batchGetAssetPropertyAggregatesAsync
([/* ... */]);
Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see Querying aggregates in the IoT SiteWise User Guide.
Parameter Syntax
$result = $client->batchGetAssetPropertyAggregates([ 'entries' => [ // REQUIRED [ 'aggregateTypes' => ['<string>', ...], // REQUIRED 'assetId' => '<string>', 'endDate' => <integer || string || DateTime>, // REQUIRED 'entryId' => '<string>', // REQUIRED 'propertyAlias' => '<string>', 'propertyId' => '<string>', 'qualities' => ['<string>', ...], 'resolution' => '<string>', // REQUIRED 'startDate' => <integer || string || DateTime>, // REQUIRED 'timeOrdering' => 'ASCENDING|DESCENDING', ], // ... ], 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- entries
-
- Required: Yes
- Type: Array of BatchGetAssetPropertyAggregatesEntry structures
The list of asset property aggregate entries for the batch get request. You can specify up to 16 entries per request.
- maxResults
-
- Type: int
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 ofmaxResults
is 4000.
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
Result Syntax
[ 'errorEntries' => [ [ 'entryId' => '<string>', 'errorCode' => 'ResourceNotFoundException|InvalidRequestException|AccessDeniedException', 'errorMessage' => '<string>', ], // ... ], 'nextToken' => '<string>', 'skippedEntries' => [ [ 'completionStatus' => 'SUCCESS|ERROR', 'entryId' => '<string>', 'errorInfo' => [ 'errorCode' => 'ResourceNotFoundException|InvalidRequestException|AccessDeniedException', 'errorTimestamp' => <DateTime>, ], ], // ... ], 'successEntries' => [ [ 'aggregatedValues' => [ [ 'quality' => 'GOOD|BAD|UNCERTAIN', 'timestamp' => <DateTime>, 'value' => [ 'average' => <float>, 'count' => <float>, 'maximum' => <float>, 'minimum' => <float>, 'standardDeviation' => <float>, 'sum' => <float>, ], ], // ... ], 'entryId' => '<string>', ], // ... ], ]
Result Details
Members
- errorEntries
-
- Required: Yes
- Type: Array of BatchGetAssetPropertyAggregatesErrorEntry structures
A list of the errors (if any) associated with the batch request. Each error entry contains the
entryId
of the entry that failed. - nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
- skippedEntries
-
- Required: Yes
- Type: Array of BatchGetAssetPropertyAggregatesSkippedEntry structures
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. - successEntries
-
- Required: Yes
- Type: Array of BatchGetAssetPropertyAggregatesSuccessEntry structures
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.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ServiceUnavailableException:
The requested service is unavailable.
BatchGetAssetPropertyValue
$result = $client->batchGetAssetPropertyValue
([/* ... */]); $promise = $client->batchGetAssetPropertyValueAsync
([/* ... */]);
Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.
Parameter Syntax
$result = $client->batchGetAssetPropertyValue([ 'entries' => [ // REQUIRED [ 'assetId' => '<string>', 'entryId' => '<string>', // REQUIRED 'propertyAlias' => '<string>', 'propertyId' => '<string>', ], // ... ], 'nextToken' => '<string>', ]);
Parameter Details
Members
- entries
-
- Required: Yes
- Type: Array of BatchGetAssetPropertyValueEntry structures
The list of asset property value entries for the batch get request. You can specify up to 128 entries per request.
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
Result Syntax
[ 'errorEntries' => [ [ 'entryId' => '<string>', 'errorCode' => 'ResourceNotFoundException|InvalidRequestException|AccessDeniedException', 'errorMessage' => '<string>', ], // ... ], 'nextToken' => '<string>', 'skippedEntries' => [ [ 'completionStatus' => 'SUCCESS|ERROR', 'entryId' => '<string>', 'errorInfo' => [ 'errorCode' => 'ResourceNotFoundException|InvalidRequestException|AccessDeniedException', 'errorTimestamp' => <DateTime>, ], ], // ... ], 'successEntries' => [ [ 'assetPropertyValue' => [ 'quality' => 'GOOD|BAD|UNCERTAIN', 'timestamp' => [ 'offsetInNanos' => <integer>, 'timeInSeconds' => <integer>, ], 'value' => [ 'booleanValue' => true || false, 'doubleValue' => <float>, 'integerValue' => <integer>, 'stringValue' => '<string>', ], ], 'entryId' => '<string>', ], // ... ], ]
Result Details
Members
- errorEntries
-
- Required: Yes
- Type: Array of BatchGetAssetPropertyValueErrorEntry structures
A list of the errors (if any) associated with the batch request. Each error entry contains the
entryId
of the entry that failed. - nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
- skippedEntries
-
- Required: Yes
- Type: Array of BatchGetAssetPropertyValueSkippedEntry structures
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. - successEntries
-
- Required: Yes
- Type: Array of BatchGetAssetPropertyValueSuccessEntry structures
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.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ServiceUnavailableException:
The requested service is unavailable.
BatchGetAssetPropertyValueHistory
$result = $client->batchGetAssetPropertyValueHistory
([/* ... */]); $promise = $client->batchGetAssetPropertyValueHistoryAsync
([/* ... */]);
Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.
Parameter Syntax
$result = $client->batchGetAssetPropertyValueHistory([ 'entries' => [ // REQUIRED [ 'assetId' => '<string>', 'endDate' => <integer || string || DateTime>, 'entryId' => '<string>', // REQUIRED 'propertyAlias' => '<string>', 'propertyId' => '<string>', 'qualities' => ['<string>', ...], 'startDate' => <integer || string || DateTime>, 'timeOrdering' => 'ASCENDING|DESCENDING', ], // ... ], 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- entries
-
- Required: Yes
- Type: Array of BatchGetAssetPropertyValueHistoryEntry structures
The list of asset property historical value entries for the batch get request. You can specify up to 16 entries per request.
- maxResults
-
- Type: int
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 ofmaxResults
is 20000.
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
Result Syntax
[ 'errorEntries' => [ [ 'entryId' => '<string>', 'errorCode' => 'ResourceNotFoundException|InvalidRequestException|AccessDeniedException', 'errorMessage' => '<string>', ], // ... ], 'nextToken' => '<string>', 'skippedEntries' => [ [ 'completionStatus' => 'SUCCESS|ERROR', 'entryId' => '<string>', 'errorInfo' => [ 'errorCode' => 'ResourceNotFoundException|InvalidRequestException|AccessDeniedException', 'errorTimestamp' => <DateTime>, ], ], // ... ], 'successEntries' => [ [ 'assetPropertyValueHistory' => [ [ 'quality' => 'GOOD|BAD|UNCERTAIN', 'timestamp' => [ 'offsetInNanos' => <integer>, 'timeInSeconds' => <integer>, ], 'value' => [ 'booleanValue' => true || false, 'doubleValue' => <float>, 'integerValue' => <integer>, 'stringValue' => '<string>', ], ], // ... ], 'entryId' => '<string>', ], // ... ], ]
Result Details
Members
- errorEntries
-
- Required: Yes
- Type: Array of BatchGetAssetPropertyValueHistoryErrorEntry structures
A list of the errors (if any) associated with the batch request. Each error entry contains the
entryId
of the entry that failed. - nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
- skippedEntries
-
- Required: Yes
- Type: Array of BatchGetAssetPropertyValueHistorySkippedEntry structures
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. - successEntries
-
- Required: Yes
- Type: Array of BatchGetAssetPropertyValueHistorySuccessEntry structures
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.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ServiceUnavailableException:
The requested service is unavailable.
BatchPutAssetPropertyValue
$result = $client->batchPutAssetPropertyValue
([/* ... */]); $promise = $client->batchPutAssetPropertyValueAsync
([/* ... */]);
Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
-
The
assetId
andpropertyId
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 authorization in the IoT SiteWise User Guide.
Parameter Syntax
$result = $client->batchPutAssetPropertyValue([ 'entries' => [ // REQUIRED [ 'assetId' => '<string>', 'entryId' => '<string>', // REQUIRED 'propertyAlias' => '<string>', 'propertyId' => '<string>', 'propertyValues' => [ // REQUIRED [ 'quality' => 'GOOD|BAD|UNCERTAIN', 'timestamp' => [ // REQUIRED 'offsetInNanos' => <integer>, 'timeInSeconds' => <integer>, // REQUIRED ], 'value' => [ // REQUIRED 'booleanValue' => true || false, 'doubleValue' => <float>, 'integerValue' => <integer>, 'stringValue' => '<string>', ], ], // ... ], ], // ... ], ]);
Parameter Details
Members
- entries
-
- Required: Yes
- Type: Array of PutAssetPropertyValueEntry structures
The list of asset property value entries for the batch put request. You can specify up to 10 entries per request.
Result Syntax
[ 'errorEntries' => [ [ 'entryId' => '<string>', 'errors' => [ [ 'errorCode' => 'ResourceNotFoundException|InvalidRequestException|InternalFailureException|ServiceUnavailableException|ThrottlingException|LimitExceededException|ConflictingOperationException|TimestampOutOfRangeException|AccessDeniedException', 'errorMessage' => '<string>', 'timestamps' => [ [ 'offsetInNanos' => <integer>, 'timeInSeconds' => <integer>, ], // ... ], ], // ... ], ], // ... ], ]
Result Details
Members
- errorEntries
-
- Required: Yes
- Type: Array of BatchPutAssetPropertyErrorEntry structures
A list of the errors (if any) associated with the batch put request. Each error entry contains the
entryId
of the entry that failed.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
- ServiceUnavailableException:
The requested service is unavailable.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
CreateAccessPolicy
$result = $client->createAccessPolicy
([/* ... */]); $promise = $client->createAccessPolicyAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createAccessPolicy([ 'accessPolicyIdentity' => [ // REQUIRED 'group' => [ 'id' => '<string>', // REQUIRED ], 'iamRole' => [ 'arn' => '<string>', // REQUIRED ], 'iamUser' => [ 'arn' => '<string>', // REQUIRED ], 'user' => [ 'id' => '<string>', // REQUIRED ], ], 'accessPolicyPermission' => 'ADMINISTRATOR|VIEWER', // REQUIRED 'accessPolicyResource' => [ // REQUIRED 'portal' => [ 'id' => '<string>', // REQUIRED ], 'project' => [ 'id' => '<string>', // REQUIRED ], ], 'clientToken' => '<string>', 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- accessPolicyIdentity
-
- Required: Yes
- Type: Identity structure
The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.
- accessPolicyPermission
-
- Required: Yes
- Type: string
The permission level for this access policy. Note that a project
ADMINISTRATOR
is also known as a project owner. - accessPolicyResource
-
- Required: Yes
- Type: Resource structure
The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
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.
Result Syntax
[ 'accessPolicyArn' => '<string>', 'accessPolicyId' => '<string>', ]
Result Details
Members
- accessPolicyArn
-
- Required: Yes
- Type: string
The ARN of the access policy, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
- accessPolicyId
-
- Required: Yes
- Type: string
The ID of the access policy.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
CreateAsset
$result = $client->createAsset
([/* ... */]); $promise = $client->createAssetAsync
([/* ... */]);
Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.
Parameter Syntax
$result = $client->createAsset([ 'assetDescription' => '<string>', 'assetExternalId' => '<string>', 'assetId' => '<string>', 'assetModelId' => '<string>', // REQUIRED 'assetName' => '<string>', // REQUIRED 'clientToken' => '<string>', 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- assetDescription
-
- Type: string
A description for the asset.
- assetExternalId
-
- Type: 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.
- assetId
-
- Type: 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.
- assetModelId
-
- Required: Yes
- Type: string
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. - assetName
-
- Required: Yes
- Type: string
A friendly name for the asset.
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
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.
Result Syntax
[ 'assetArn' => '<string>', 'assetId' => '<string>', 'assetStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED', ], ]
Result Details
Members
- assetArn
-
- Required: Yes
- Type: string
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
- assetId
-
- Required: Yes
- Type: 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.
- assetStatus
-
- Required: Yes
- Type: AssetStatus structure
The status of the asset, which contains a state (
CREATING
after successfully calling this operation) and any error message.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceAlreadyExistsException:
The resource already exists.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
CreateAssetModel
$result = $client->createAssetModel
([/* ... */]); $promise = $client->createAssetModelAsync
([/* ... */]);
Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in 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.
Parameter Syntax
$result = $client->createAssetModel([ 'assetModelCompositeModels' => [ [ 'description' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', // REQUIRED 'properties' => [ [ 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', // REQUIRED 'dataTypeSpec' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', // REQUIRED 'type' => [ // REQUIRED 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ 'processingConfig' => [ 'forwardingConfig' => [ // REQUIRED 'state' => 'DISABLED|ENABLED', // REQUIRED ], ], ], 'metric' => [ 'expression' => '<string>', // REQUIRED 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', // REQUIRED ], 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], 'window' => [ // REQUIRED 'tumbling' => [ 'interval' => '<string>', // REQUIRED 'offset' => '<string>', ], ], ], 'transform' => [ 'expression' => '<string>', // REQUIRED 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', // REQUIRED 'forwardingConfig' => [ 'state' => 'DISABLED|ENABLED', // REQUIRED ], ], 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], ], ], 'unit' => '<string>', ], // ... ], 'type' => '<string>', // REQUIRED ], // ... ], 'assetModelDescription' => '<string>', 'assetModelExternalId' => '<string>', 'assetModelHierarchies' => [ [ 'childAssetModelId' => '<string>', // REQUIRED 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', // REQUIRED ], // ... ], 'assetModelId' => '<string>', 'assetModelName' => '<string>', // REQUIRED 'assetModelProperties' => [ [ 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', // REQUIRED 'dataTypeSpec' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', // REQUIRED 'type' => [ // REQUIRED 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ 'processingConfig' => [ 'forwardingConfig' => [ // REQUIRED 'state' => 'DISABLED|ENABLED', // REQUIRED ], ], ], 'metric' => [ 'expression' => '<string>', // REQUIRED 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', // REQUIRED ], 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], 'window' => [ // REQUIRED 'tumbling' => [ 'interval' => '<string>', // REQUIRED 'offset' => '<string>', ], ], ], 'transform' => [ 'expression' => '<string>', // REQUIRED 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', // REQUIRED 'forwardingConfig' => [ 'state' => 'DISABLED|ENABLED', // REQUIRED ], ], 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], ], ], 'unit' => '<string>', ], // ... ], 'assetModelType' => 'ASSET_MODEL|COMPONENT_MODEL', 'clientToken' => '<string>', 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- assetModelCompositeModels
-
- Type: Array of AssetModelCompositeModelDefinition structures
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.
- assetModelDescription
-
- Type: string
A description for the asset model.
- assetModelExternalId
-
- Type: 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.
- assetModelHierarchies
-
- Type: Array of AssetModelHierarchyDefinition structures
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.
- assetModelId
-
- Type: string
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.
- assetModelName
-
- Required: Yes
- Type: string
A unique name for the asset model.
- assetModelProperties
-
- Type: Array of AssetModelPropertyDefinition structures
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.
- assetModelType
-
- Type: 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.
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
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.
Result Syntax
[ 'assetModelArn' => '<string>', 'assetModelId' => '<string>', 'assetModelStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|PROPAGATING|DELETING|FAILED', ], ]
Result Details
Members
- assetModelArn
-
- Required: Yes
- Type: string
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
- assetModelId
-
- Required: Yes
- Type: string
The ID of the asset model, in UUID format. You can use this ID when you call other IoT SiteWise API operations.
- assetModelStatus
-
- Required: Yes
- Type: AssetModelStatus structure
The status of the asset model, which contains a state (
CREATING
after successfully calling this operation) and any error message.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceAlreadyExistsException:
The resource already exists.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
CreateAssetModelCompositeModel
$result = $client->createAssetModelCompositeModel
([/* ... */]); $promise = $client->createAssetModelCompositeModelAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->createAssetModelCompositeModel([ 'assetModelCompositeModelDescription' => '<string>', 'assetModelCompositeModelExternalId' => '<string>', 'assetModelCompositeModelId' => '<string>', 'assetModelCompositeModelName' => '<string>', // REQUIRED 'assetModelCompositeModelProperties' => [ [ 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', // REQUIRED 'dataTypeSpec' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', // REQUIRED 'type' => [ // REQUIRED 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ 'processingConfig' => [ 'forwardingConfig' => [ // REQUIRED 'state' => 'DISABLED|ENABLED', // REQUIRED ], ], ], 'metric' => [ 'expression' => '<string>', // REQUIRED 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', // REQUIRED ], 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], 'window' => [ // REQUIRED 'tumbling' => [ 'interval' => '<string>', // REQUIRED 'offset' => '<string>', ], ], ], 'transform' => [ 'expression' => '<string>', // REQUIRED 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', // REQUIRED 'forwardingConfig' => [ 'state' => 'DISABLED|ENABLED', // REQUIRED ], ], 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], ], ], 'unit' => '<string>', ], // ... ], 'assetModelCompositeModelType' => '<string>', // REQUIRED 'assetModelId' => '<string>', // REQUIRED 'clientToken' => '<string>', 'composedAssetModelId' => '<string>', 'ifMatch' => '<string>', 'ifNoneMatch' => '<string>', 'matchForVersionType' => 'LATEST|ACTIVE', 'parentAssetModelCompositeModelId' => '<string>', ]);
Parameter Details
Members
- assetModelCompositeModelDescription
-
- Type: string
A description for the composite model.
- assetModelCompositeModelExternalId
-
- Type: 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. - assetModelCompositeModelId
-
- Type: 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.
- assetModelCompositeModelName
-
- Required: Yes
- Type: string
A unique name for the composite model.
- assetModelCompositeModelProperties
-
- Type: Array of AssetModelPropertyDefinition structures
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.
- assetModelCompositeModelType
-
- Required: Yes
- Type: string
The composite model type. Valid values are
AWS/ALARM
,CUSTOM
, orAWS/L4E_ANOMALY
. - assetModelId
-
- Required: Yes
- Type: string
The ID of the asset model this composite model is a part of.
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- composedAssetModelId
-
- Type: string
The ID of a component model which is reused to create this composite model.
- ifMatch
-
- Type: 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. - ifNoneMatch
-
- Type: string
Accepts * to reject the create request if an active version (specified using
matchForVersionType
asACTIVE
) already exists for the asset model. - matchForVersionType
-
- Type: string
Specifies the asset model version type (
LATEST
orACTIVE
) used in conjunction withIf-Match
orIf-None-Match
headers to determine the target ETag for the create operation. - parentAssetModelCompositeModelId
-
- Type: string
The ID of the parent composite model in this asset model relationship.
Result Syntax
[ 'assetModelCompositeModelId' => '<string>', 'assetModelCompositeModelPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'assetModelStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|PROPAGATING|DELETING|FAILED', ], ]
Result Details
Members
- assetModelCompositeModelId
-
- Required: Yes
- Type: string
The ID of the composed asset model. You can use this ID when you call other IoT SiteWise APIs.
- assetModelCompositeModelPath
-
- Required: Yes
- Type: Array of AssetModelCompositeModelPathSegment structures
The path to the composite model listing the parent composite models.
- assetModelStatus
-
- Required: Yes
- Type: AssetModelStatus structure
Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide.
Errors
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
- PreconditionFailedException:
The precondition in one or more of the request-header fields evaluated to
FALSE
.- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceAlreadyExistsException:
The resource already exists.
- ResourceNotFoundException:
The requested resource can't be found.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
CreateBulkImportJob
$result = $client->createBulkImportJob
([/* ... */]); $promise = $client->createBulkImportJobAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createBulkImportJob([ 'adaptiveIngestion' => true || false, 'deleteFilesAfterImport' => true || false, 'errorReportLocation' => [ // REQUIRED 'bucket' => '<string>', // REQUIRED 'prefix' => '<string>', // REQUIRED ], 'files' => [ // REQUIRED [ 'bucket' => '<string>', // REQUIRED 'key' => '<string>', // REQUIRED 'versionId' => '<string>', ], // ... ], 'jobConfiguration' => [ // REQUIRED 'fileFormat' => [ // REQUIRED 'csv' => [ 'columnNames' => ['<string>', ...], // REQUIRED ], 'parquet' => [ ], ], ], 'jobName' => '<string>', // REQUIRED 'jobRoleArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- adaptiveIngestion
-
- Type: boolean
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.
- deleteFilesAfterImport
-
- Type: boolean
If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.
- errorReportLocation
-
- Required: Yes
- Type: ErrorReportLocation structure
The Amazon S3 destination where errors associated with the job creation request are saved.
- files
-
- Required: Yes
- Type: Array of File structures
The files in the specified Amazon S3 bucket that contain your data.
- jobConfiguration
-
- Required: Yes
- Type: JobConfiguration structure
Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
- jobName
-
- Required: Yes
- Type: string
The unique name that helps identify the job request.
- jobRoleArn
-
- Required: Yes
- Type: string
The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
Result Syntax
[ 'jobId' => '<string>', 'jobName' => '<string>', 'jobStatus' => 'PENDING|CANCELLED|RUNNING|COMPLETED|FAILED|COMPLETED_WITH_FAILURES', ]
Result Details
Members
- jobId
-
- Required: Yes
- Type: string
The ID of the job.
- jobName
-
- Required: Yes
- Type: string
The unique name that helps identify the job request.
- jobStatus
-
- Required: Yes
- Type: 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.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceAlreadyExistsException:
The resource already exists.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
CreateDashboard
$result = $client->createDashboard
([/* ... */]); $promise = $client->createDashboardAsync
([/* ... */]);
Creates a dashboard in an IoT SiteWise Monitor project.
Parameter Syntax
$result = $client->createDashboard([ 'clientToken' => '<string>', 'dashboardDefinition' => '<string>', // REQUIRED 'dashboardDescription' => '<string>', 'dashboardName' => '<string>', // REQUIRED 'projectId' => '<string>', // REQUIRED 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- dashboardDefinition
-
- Required: Yes
- Type: string
The dashboard definition specified in a JSON literal.
-
IoT SiteWise Monitor (Classic) see Create dashboards (CLI)
-
IoT SiteWise Monitor (AI-aware) see Create dashboards (CLI)
in the IoT SiteWise User Guide
- dashboardDescription
-
- Type: string
A description for the dashboard.
- dashboardName
-
- Required: Yes
- Type: string
A friendly name for the dashboard.
- projectId
-
- Required: Yes
- Type: string
The ID of the project in which to create the dashboard.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
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.
Result Syntax
[ 'dashboardArn' => '<string>', 'dashboardId' => '<string>', ]
Result Details
Members
- dashboardArn
-
- Required: Yes
- Type: string
The ARN of the dashboard, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
- dashboardId
-
- Required: Yes
- Type: string
The ID of the dashboard.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
CreateDataset
$result = $client->createDataset
([/* ... */]); $promise = $client->createDatasetAsync
([/* ... */]);
Creates a dataset to connect an external datasource.
Parameter Syntax
$result = $client->createDataset([ 'clientToken' => '<string>', 'datasetDescription' => '<string>', 'datasetId' => '<string>', 'datasetName' => '<string>', // REQUIRED 'datasetSource' => [ // REQUIRED 'sourceDetail' => [ 'kendra' => [ 'knowledgeBaseArn' => '<string>', // REQUIRED 'roleArn' => '<string>', // REQUIRED ], ], 'sourceFormat' => 'KNOWLEDGE_BASE', // REQUIRED 'sourceType' => 'KENDRA', // REQUIRED ], 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- datasetDescription
-
- Type: string
A description about the dataset, and its functionality.
- datasetId
-
- Type: string
The ID of the dataset.
- datasetName
-
- Required: Yes
- Type: string
The name of the dataset.
- datasetSource
-
- Required: Yes
- Type: DatasetSource structure
The data source for the dataset.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
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.
Result Syntax
[ 'datasetArn' => '<string>', 'datasetId' => '<string>', 'datasetStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED', ], ]
Result Details
Members
- datasetArn
-
- Required: Yes
- Type: string
The ARN of the dataset. The format is
arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}
. - datasetId
-
- Required: Yes
- Type: string
The ID of the dataset.
- datasetStatus
-
- Required: Yes
- Type: DatasetStatus structure
The status of the dataset. This contains the state and any error messages. State is
CREATING
after a successfull call to this API, and any associated error message. The state isACTIVE
when ready to use.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceAlreadyExistsException:
The resource already exists.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
CreateGateway
$result = $client->createGateway
([/* ... */]); $promise = $client->createGatewayAsync
([/* ... */]);
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide.
Parameter Syntax
$result = $client->createGateway([ 'gatewayName' => '<string>', // REQUIRED 'gatewayPlatform' => [ // REQUIRED 'greengrass' => [ 'groupArn' => '<string>', // REQUIRED ], 'greengrassV2' => [ 'coreDeviceThingName' => '<string>', // REQUIRED ], 'siemensIE' => [ 'iotCoreThingName' => '<string>', // REQUIRED ], ], 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- gatewayName
-
- Required: Yes
- Type: string
A unique name for the gateway.
- gatewayPlatform
-
- Required: Yes
- Type: GatewayPlatform structure
The gateway's platform. You can only specify one platform in a gateway.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
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.
Result Syntax
[ 'gatewayArn' => '<string>', 'gatewayId' => '<string>', ]
Result Details
Members
- gatewayArn
-
- Required: Yes
- Type: string
The ARN of the gateway, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
- gatewayId
-
- Required: Yes
- Type: string
The ID of the gateway device. You can use this ID when you call other IoT SiteWise API operations.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceAlreadyExistsException:
The resource already exists.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
CreatePortal
$result = $client->createPortal
([/* ... */]); $promise = $client->createPortalAsync
([/* ... */]);
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 administrators in the IoT SiteWise User Guide.
Parameter Syntax
$result = $client->createPortal([ 'alarms' => [ 'alarmRoleArn' => '<string>', // REQUIRED 'notificationLambdaArn' => '<string>', ], 'clientToken' => '<string>', 'notificationSenderEmail' => '<string>', 'portalAuthMode' => 'IAM|SSO', 'portalContactEmail' => '<string>', // REQUIRED 'portalDescription' => '<string>', 'portalLogoImageFile' => [ 'data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'type' => 'PNG', // REQUIRED ], 'portalName' => '<string>', // REQUIRED 'portalType' => 'SITEWISE_PORTAL_V1|SITEWISE_PORTAL_V2', 'portalTypeConfiguration' => [ '<PortalTypeKey>' => [ 'portalTools' => ['<string>', ...], ], // ... ], 'roleArn' => '<string>', // REQUIRED 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- alarms
-
- Type: Alarms structure
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.
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- notificationSenderEmail
-
- Type: 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.
- portalAuthMode
-
- Type: 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
- portalContactEmail
-
- Required: Yes
- Type: string
The Amazon Web Services administrator's contact email address.
- portalDescription
-
- Type: string
A description for the portal.
- portalLogoImageFile
-
- Type: ImageFile structure
A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.
- portalName
-
- Required: Yes
- Type: string
A friendly name for the portal.
- portalType
-
- Type: string
Define the type of portal. The value for IoT SiteWise Monitor (Classic) is
SITEWISE_PORTAL_V1
. The value for IoT SiteWise Monitor (AI-aware) isSITEWISE_PORTAL_V2
. - portalTypeConfiguration
-
- Type: Associative array of custom strings keys (PortalTypeKey) to PortalTypeEntry structures
The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is
SITEWISE_PORTAL_V1
. The value for IoT SiteWise Monitor (AI-aware) isSITEWISE_PORTAL_V2
. - roleArn
-
- Required: Yes
- Type: 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.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
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.
Result Syntax
[ 'portalArn' => '<string>', 'portalId' => '<string>', 'portalStartUrl' => '<string>', 'portalStatus' => [ 'error' => [ 'code' => 'INTERNAL_FAILURE|VALIDATION_ERROR|LIMIT_EXCEEDED', 'message' => '<string>', ], 'state' => 'CREATING|PENDING|UPDATING|DELETING|ACTIVE|FAILED', ], 'ssoApplicationId' => '<string>', ]
Result Details
Members
- portalArn
-
- Required: Yes
- Type: string
The ARN of the portal, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
- portalId
-
- Required: Yes
- Type: string
The ID of the created portal.
- portalStartUrl
-
- Required: Yes
- Type: 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.
- portalStatus
-
- Required: Yes
- Type: PortalStatus structure
The status of the portal, which contains a state (
CREATING
after successfully calling this operation) and any error message. - ssoApplicationId
-
- Required: Yes
- Type: string
The associated IAM Identity Center application ID, if the portal uses IAM Identity Center.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
CreateProject
$result = $client->createProject
([/* ... */]); $promise = $client->createProjectAsync
([/* ... */]);
Creates a project in the specified portal.
Make sure that the project name and description don't contain confidential information.
Parameter Syntax
$result = $client->createProject([ 'clientToken' => '<string>', 'portalId' => '<string>', // REQUIRED 'projectDescription' => '<string>', 'projectName' => '<string>', // REQUIRED 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- portalId
-
- Required: Yes
- Type: string
The ID of the portal in which to create the project.
- projectDescription
-
- Type: string
A description for the project.
- projectName
-
- Required: Yes
- Type: string
A friendly name for the project.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
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.
Result Syntax
[ 'projectArn' => '<string>', 'projectId' => '<string>', ]
Result Details
Members
- projectArn
-
- Required: Yes
- Type: string
The ARN of the project, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
- projectId
-
- Required: Yes
- Type: string
The ID of the project.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
DeleteAccessPolicy
$result = $client->deleteAccessPolicy
([/* ... */]); $promise = $client->deleteAccessPolicyAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteAccessPolicy([ 'accessPolicyId' => '<string>', // REQUIRED 'clientToken' => '<string>', ]);
Parameter Details
Members
- accessPolicyId
-
- Required: Yes
- Type: string
The ID of the access policy to be deleted.
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DeleteAsset
$result = $client->deleteAsset
([/* ... */]); $promise = $client->deleteAssetAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteAsset([ 'assetId' => '<string>', // REQUIRED 'clientToken' => '<string>', ]);
Parameter Details
Members
- assetId
-
- Required: Yes
- Type: string
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. - clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Result Syntax
[ 'assetStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED', ], ]
Result Details
Members
- assetStatus
-
- Required: Yes
- Type: AssetStatus structure
The status of the asset, which contains a state (
DELETING
after successfully calling this operation) and any error message.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
DeleteAssetModel
$result = $client->deleteAssetModel
([/* ... */]); $promise = $client->deleteAssetModelAsync
([/* ... */]);
Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.
Parameter Syntax
$result = $client->deleteAssetModel([ 'assetModelId' => '<string>', // REQUIRED 'clientToken' => '<string>', 'ifMatch' => '<string>', 'ifNoneMatch' => '<string>', 'matchForVersionType' => 'LATEST|ACTIVE', ]);
Parameter Details
Members
- assetModelId
-
- Required: Yes
- Type: string
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. - clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- ifMatch
-
- Type: 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. - ifNoneMatch
-
- Type: string
Accepts * to reject the delete request if an active version (specified using
matchForVersionType
asACTIVE
) already exists for the asset model. - matchForVersionType
-
- Type: string
Specifies the asset model version type (
LATEST
orACTIVE
) used in conjunction withIf-Match
orIf-None-Match
headers to determine the target ETag for the delete operation.
Result Syntax
[ 'assetModelStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|PROPAGATING|DELETING|FAILED', ], ]
Result Details
Members
- assetModelStatus
-
- Required: Yes
- Type: AssetModelStatus structure
The status of the asset model, which contains a state (
DELETING
after successfully calling this operation) and any error message.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
- PreconditionFailedException:
The precondition in one or more of the request-header fields evaluated to
FALSE
.
DeleteAssetModelCompositeModel
$result = $client->deleteAssetModelCompositeModel
([/* ... */]); $promise = $client->deleteAssetModelCompositeModelAsync
([/* ... */]);
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 models in the IoT SiteWise User Guide.
Parameter Syntax
$result = $client->deleteAssetModelCompositeModel([ 'assetModelCompositeModelId' => '<string>', // REQUIRED 'assetModelId' => '<string>', // REQUIRED 'clientToken' => '<string>', 'ifMatch' => '<string>', 'ifNoneMatch' => '<string>', 'matchForVersionType' => 'LATEST|ACTIVE', ]);
Parameter Details
Members
- assetModelCompositeModelId
-
- Required: Yes
- Type: string
The ID of a composite model on this asset model.
- assetModelId
-
- Required: Yes
- Type: string
The ID of the asset model, in UUID format.
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- ifMatch
-
- Type: 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. - ifNoneMatch
-
- Type: string
Accepts * to reject the delete request if an active version (specified using
matchForVersionType
asACTIVE
) already exists for the asset model. - matchForVersionType
-
- Type: string
Specifies the asset model version type (
LATEST
orACTIVE
) used in conjunction withIf-Match
orIf-None-Match
headers to determine the target ETag for the delete operation.
Result Syntax
[ 'assetModelStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|PROPAGATING|DELETING|FAILED', ], ]
Result Details
Members
- assetModelStatus
-
- Required: Yes
- Type: AssetModelStatus structure
Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
- PreconditionFailedException:
The precondition in one or more of the request-header fields evaluated to
FALSE
.
DeleteDashboard
$result = $client->deleteDashboard
([/* ... */]); $promise = $client->deleteDashboardAsync
([/* ... */]);
Deletes a dashboard from IoT SiteWise Monitor.
Parameter Syntax
$result = $client->deleteDashboard([ 'clientToken' => '<string>', 'dashboardId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- dashboardId
-
- Required: Yes
- Type: string
The ID of the dashboard to delete.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DeleteDataset
$result = $client->deleteDataset
([/* ... */]); $promise = $client->deleteDatasetAsync
([/* ... */]);
Deletes a dataset. This cannot be undone.
Parameter Syntax
$result = $client->deleteDataset([ 'clientToken' => '<string>', 'datasetId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- datasetId
-
- Required: Yes
- Type: string
The ID of the dataset.
Result Syntax
[ 'datasetStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED', ], ]
Result Details
Members
- datasetStatus
-
- Required: Yes
- Type: DatasetStatus structure
The status of the dataset. This contains the state and any error messages. State is
DELETING
after a successfull call to this API, and any associated error message.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
DeleteGateway
$result = $client->deleteGateway
([/* ... */]); $promise = $client->deleteGatewayAsync
([/* ... */]);
Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.
Parameter Syntax
$result = $client->deleteGateway([ 'gatewayId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- gatewayId
-
- Required: Yes
- Type: string
The ID of the gateway to delete.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DeletePortal
$result = $client->deletePortal
([/* ... */]); $promise = $client->deletePortalAsync
([/* ... */]);
Deletes a portal from IoT SiteWise Monitor.
Parameter Syntax
$result = $client->deletePortal([ 'clientToken' => '<string>', 'portalId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- portalId
-
- Required: Yes
- Type: string
The ID of the portal to delete.
Result Syntax
[ 'portalStatus' => [ 'error' => [ 'code' => 'INTERNAL_FAILURE|VALIDATION_ERROR|LIMIT_EXCEEDED', 'message' => '<string>', ], 'state' => 'CREATING|PENDING|UPDATING|DELETING|ACTIVE|FAILED', ], ]
Result Details
Members
- portalStatus
-
- Required: Yes
- Type: PortalStatus structure
The status of the portal, which contains a state (
DELETING
after successfully calling this operation) and any error message.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
DeleteProject
$result = $client->deleteProject
([/* ... */]); $promise = $client->deleteProjectAsync
([/* ... */]);
Deletes a project from IoT SiteWise Monitor.
Parameter Syntax
$result = $client->deleteProject([ 'clientToken' => '<string>', 'projectId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- projectId
-
- Required: Yes
- Type: string
The ID of the project.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DeleteTimeSeries
$result = $client->deleteTimeSeries
([/* ... */]); $promise = $client->deleteTimeSeriesAsync
([/* ... */]);
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
andpropertyId
that identifies the asset property.
-
Parameter Syntax
$result = $client->deleteTimeSeries([ 'alias' => '<string>', 'assetId' => '<string>', 'clientToken' => '<string>', 'propertyId' => '<string>', ]);
Parameter Details
Members
- alias
-
- Type: string
The alias that identifies the time series.
- assetId
-
- Type: 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. - clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- propertyId
-
- Type: 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.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
DescribeAccessPolicy
$result = $client->describeAccessPolicy
([/* ... */]); $promise = $client->describeAccessPolicyAsync
([/* ... */]);
Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
Parameter Syntax
$result = $client->describeAccessPolicy([ 'accessPolicyId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- accessPolicyId
-
- Required: Yes
- Type: string
The ID of the access policy.
Result Syntax
[ 'accessPolicyArn' => '<string>', 'accessPolicyCreationDate' => <DateTime>, 'accessPolicyId' => '<string>', 'accessPolicyIdentity' => [ 'group' => [ 'id' => '<string>', ], 'iamRole' => [ 'arn' => '<string>', ], 'iamUser' => [ 'arn' => '<string>', ], 'user' => [ 'id' => '<string>', ], ], 'accessPolicyLastUpdateDate' => <DateTime>, 'accessPolicyPermission' => 'ADMINISTRATOR|VIEWER', 'accessPolicyResource' => [ 'portal' => [ 'id' => '<string>', ], 'project' => [ 'id' => '<string>', ], ], ]
Result Details
Members
- accessPolicyArn
-
- Required: Yes
- Type: string
The ARN of the access policy, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
- accessPolicyCreationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the access policy was created, in Unix epoch time.
- accessPolicyId
-
- Required: Yes
- Type: string
The ID of the access policy.
- accessPolicyIdentity
-
- Required: Yes
- Type: Identity structure
The identity (IAM Identity Center user, IAM Identity Center group, or IAM user) to which this access policy applies.
- accessPolicyLastUpdateDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the access policy was last updated, in Unix epoch time.
- accessPolicyPermission
-
- Required: Yes
- Type: string
The access policy permission. Note that a project
ADMINISTRATOR
is also known as a project owner. - accessPolicyResource
-
- Required: Yes
- Type: Resource structure
The IoT SiteWise Monitor resource (portal or project) to which this access policy provides access.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeAction
$result = $client->describeAction
([/* ... */]); $promise = $client->describeActionAsync
([/* ... */]);
Retrieves information about an action.
Parameter Syntax
$result = $client->describeAction([ 'actionId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- actionId
-
- Required: Yes
- Type: string
The ID of the action.
Result Syntax
[ 'actionDefinitionId' => '<string>', 'actionId' => '<string>', 'actionPayload' => [ 'stringValue' => '<string>', ], 'executionTime' => <DateTime>, 'targetResource' => [ 'assetId' => '<string>', ], ]
Result Details
Members
- actionDefinitionId
-
- Required: Yes
- Type: string
The ID of the action definition.
- actionId
-
- Required: Yes
- Type: string
The ID of the action.
- actionPayload
-
- Required: Yes
- Type: ActionPayload structure
The JSON payload of the action.
- executionTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the action was executed.
- targetResource
-
- Required: Yes
- Type: TargetResource structure
The resource the action will be taken on.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeAsset
$result = $client->describeAsset
([/* ... */]); $promise = $client->describeAssetAsync
([/* ... */]);
Retrieves information about an asset.
Parameter Syntax
$result = $client->describeAsset([ 'assetId' => '<string>', // REQUIRED 'excludeProperties' => true || false, ]);
Parameter Details
Members
- assetId
-
- Required: Yes
- Type: 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. - excludeProperties
-
- Type: boolean
Whether or not to exclude asset properties from the response.
Result Syntax
[ 'assetArn' => '<string>', 'assetCompositeModelSummaries' => [ [ 'description' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', 'path' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'type' => '<string>', ], // ... ], 'assetCompositeModels' => [ [ 'description' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', 'properties' => [ [ 'alias' => '<string>', 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', 'dataTypeSpec' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', 'notification' => [ 'state' => 'ENABLED|DISABLED', 'topic' => '<string>', ], 'path' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'unit' => '<string>', ], // ... ], 'type' => '<string>', ], // ... ], 'assetCreationDate' => <DateTime>, 'assetDescription' => '<string>', 'assetExternalId' => '<string>', 'assetHierarchies' => [ [ 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', ], // ... ], 'assetId' => '<string>', 'assetLastUpdateDate' => <DateTime>, 'assetModelId' => '<string>', 'assetName' => '<string>', 'assetProperties' => [ [ 'alias' => '<string>', 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', 'dataTypeSpec' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', 'notification' => [ 'state' => 'ENABLED|DISABLED', 'topic' => '<string>', ], 'path' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'unit' => '<string>', ], // ... ], 'assetStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED', ], ]
Result Details
Members
- assetArn
-
- Required: Yes
- Type: string
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
- assetCompositeModelSummaries
-
- Type: Array of AssetCompositeModelSummary structures
The list of the immediate child custom composite model summaries for the asset.
- assetCompositeModels
-
- Type: Array of AssetCompositeModel structures
The composite models for the asset.
- assetCreationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the asset was created, in Unix epoch time.
- assetDescription
-
- Type: string
A description for the asset.
- assetExternalId
-
- Type: string
The external ID of the asset, if any.
- assetHierarchies
-
- Required: Yes
- Type: Array of AssetHierarchy structures
A list of asset hierarchies that each contain a
hierarchyId
. A hierarchy specifies allowed parent/child asset relationships. - assetId
-
- Required: Yes
- Type: string
The ID of the asset, in UUID format.
- assetLastUpdateDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the asset was last updated, in Unix epoch time.
- assetModelId
-
- Required: Yes
- Type: string
The ID of the asset model that was used to create the asset.
- assetName
-
- Required: Yes
- Type: string
The name of the asset.
- assetProperties
-
- Required: Yes
- Type: Array of AssetProperty structures
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. - assetStatus
-
- Required: Yes
- Type: AssetStatus structure
The current status of the asset, which contains a state and any error message.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeAssetCompositeModel
$result = $client->describeAssetCompositeModel
([/* ... */]); $promise = $client->describeAssetCompositeModelAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeAssetCompositeModel([ 'assetCompositeModelId' => '<string>', // REQUIRED 'assetId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- assetCompositeModelId
-
- Required: Yes
- Type: string
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. - assetId
-
- Required: Yes
- Type: 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.
Result Syntax
[ 'actionDefinitions' => [ [ 'actionDefinitionId' => '<string>', 'actionName' => '<string>', 'actionType' => '<string>', ], // ... ], 'assetCompositeModelDescription' => '<string>', 'assetCompositeModelExternalId' => '<string>', 'assetCompositeModelId' => '<string>', 'assetCompositeModelName' => '<string>', 'assetCompositeModelPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'assetCompositeModelProperties' => [ [ 'alias' => '<string>', 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', 'dataTypeSpec' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', 'notification' => [ 'state' => 'ENABLED|DISABLED', 'topic' => '<string>', ], 'path' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'unit' => '<string>', ], // ... ], 'assetCompositeModelSummaries' => [ [ 'description' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', 'path' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'type' => '<string>', ], // ... ], 'assetCompositeModelType' => '<string>', 'assetId' => '<string>', ]
Result Details
Members
- actionDefinitions
-
- Type: Array of ActionDefinition structures
The available actions for a composite model on this asset.
- assetCompositeModelDescription
-
- Required: Yes
- Type: string
A description for the composite model.
- assetCompositeModelExternalId
-
- Type: string
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. - assetCompositeModelId
-
- Required: Yes
- Type: string
The ID of a composite model on this asset.
- assetCompositeModelName
-
- Required: Yes
- Type: string
The unique, friendly name for the composite model.
- assetCompositeModelPath
-
- Required: Yes
- Type: Array of AssetCompositeModelPathSegment structures
The path to the composite model listing the parent composite models.
- assetCompositeModelProperties
-
- Required: Yes
- Type: Array of AssetProperty structures
The property definitions of the composite model that was used to create the asset.
- assetCompositeModelSummaries
-
- Required: Yes
- Type: Array of AssetCompositeModelSummary structures
The list of composite model summaries.
- assetCompositeModelType
-
- Required: Yes
- Type: string
The composite model type. Valid values are
AWS/ALARM
,CUSTOM
, orAWS/L4E_ANOMALY
. - assetId
-
- Required: Yes
- Type: 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.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeAssetModel
$result = $client->describeAssetModel
([/* ... */]); $promise = $client->describeAssetModelAsync
([/* ... */]);
Retrieves information about an asset model.
Parameter Syntax
$result = $client->describeAssetModel([ 'assetModelId' => '<string>', // REQUIRED 'assetModelVersion' => '<string>', 'excludeProperties' => true || false, ]);
Parameter Details
Members
- assetModelId
-
- Required: Yes
- Type: 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. - assetModelVersion
-
- Type: 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. - excludeProperties
-
- Type: boolean
Whether or not to exclude asset model properties from the response.
Result Syntax
[ 'assetModelArn' => '<string>', 'assetModelCompositeModelSummaries' => [ [ 'description' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', 'path' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'type' => '<string>', ], // ... ], 'assetModelCompositeModels' => [ [ 'description' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', 'properties' => [ [ 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', 'dataTypeSpec' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', 'path' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'type' => [ 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ 'processingConfig' => [ 'forwardingConfig' => [ 'state' => 'DISABLED|ENABLED', ], ], ], 'metric' => [ 'expression' => '<string>', 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', ], 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], 'window' => [ 'tumbling' => [ 'interval' => '<string>', 'offset' => '<string>', ], ], ], 'transform' => [ 'expression' => '<string>', 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', 'forwardingConfig' => [ 'state' => 'DISABLED|ENABLED', ], ], 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], ], ], 'unit' => '<string>', ], // ... ], 'type' => '<string>', ], // ... ], 'assetModelCreationDate' => <DateTime>, 'assetModelDescription' => '<string>', 'assetModelExternalId' => '<string>', 'assetModelHierarchies' => [ [ 'childAssetModelId' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', ], // ... ], 'assetModelId' => '<string>', 'assetModelLastUpdateDate' => <DateTime>, 'assetModelName' => '<string>', 'assetModelProperties' => [ [ 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', 'dataTypeSpec' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', 'path' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'type' => [ 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ 'processingConfig' => [ 'forwardingConfig' => [ 'state' => 'DISABLED|ENABLED', ], ], ], 'metric' => [ 'expression' => '<string>', 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', ], 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], 'window' => [ 'tumbling' => [ 'interval' => '<string>', 'offset' => '<string>', ], ], ], 'transform' => [ 'expression' => '<string>', 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', 'forwardingConfig' => [ 'state' => 'DISABLED|ENABLED', ], ], 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], ], ], 'unit' => '<string>', ], // ... ], 'assetModelStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|PROPAGATING|DELETING|FAILED', ], 'assetModelType' => 'ASSET_MODEL|COMPONENT_MODEL', 'assetModelVersion' => '<string>', 'eTag' => '<string>', ]
Result Details
Members
- assetModelArn
-
- Required: Yes
- Type: string
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
- assetModelCompositeModelSummaries
-
- Type: Array of AssetModelCompositeModelSummary structures
The list of the immediate child custom composite model summaries for the asset model.
- assetModelCompositeModels
-
- Type: Array of AssetModelCompositeModel structures
The list of built-in composite models for the asset model, such as those with those of type
AWS/ALARMS
. - assetModelCreationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the asset model was created, in Unix epoch time.
- assetModelDescription
-
- Required: Yes
- Type: string
The asset model's description.
- assetModelExternalId
-
- Type: string
The external ID of the asset model, if any.
- assetModelHierarchies
-
- Required: Yes
- Type: Array of AssetModelHierarchy structures
A list of asset model hierarchies that each contain a
childAssetModelId
and ahierarchyId
(namedid
). A hierarchy specifies allowed parent/child asset relationships for an asset model. - assetModelId
-
- Required: Yes
- Type: string
The ID of the asset model, in UUID format.
- assetModelLastUpdateDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the asset model was last updated, in Unix epoch time.
- assetModelName
-
- Required: Yes
- Type: string
The name of the asset model.
- assetModelProperties
-
- Required: Yes
- Type: Array of AssetModelProperty structures
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. - assetModelStatus
-
- Required: Yes
- Type: AssetModelStatus structure
The current status of the asset model, which contains a state and any error message.
- assetModelType
-
- Type: 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.
- assetModelVersion
-
- Type: string
The version of the asset model. See Asset model versions in the IoT SiteWise User Guide.
- eTag
-
- Type: 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.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeAssetModelCompositeModel
$result = $client->describeAssetModelCompositeModel
([/* ... */]); $promise = $client->describeAssetModelCompositeModelAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeAssetModelCompositeModel([ 'assetModelCompositeModelId' => '<string>', // REQUIRED 'assetModelId' => '<string>', // REQUIRED 'assetModelVersion' => '<string>', ]);
Parameter Details
Members
- assetModelCompositeModelId
-
- Required: Yes
- Type: string
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. - assetModelId
-
- Required: Yes
- Type: 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. - assetModelVersion
-
- Type: 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.
Result Syntax
[ 'actionDefinitions' => [ [ 'actionDefinitionId' => '<string>', 'actionName' => '<string>', 'actionType' => '<string>', ], // ... ], 'assetModelCompositeModelDescription' => '<string>', 'assetModelCompositeModelExternalId' => '<string>', 'assetModelCompositeModelId' => '<string>', 'assetModelCompositeModelName' => '<string>', 'assetModelCompositeModelPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'assetModelCompositeModelProperties' => [ [ 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', 'dataTypeSpec' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', 'path' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'type' => [ 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ 'processingConfig' => [ 'forwardingConfig' => [ 'state' => 'DISABLED|ENABLED', ], ], ], 'metric' => [ 'expression' => '<string>', 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', ], 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], 'window' => [ 'tumbling' => [ 'interval' => '<string>', 'offset' => '<string>', ], ], ], 'transform' => [ 'expression' => '<string>', 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', 'forwardingConfig' => [ 'state' => 'DISABLED|ENABLED', ], ], 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], ], ], 'unit' => '<string>', ], // ... ], 'assetModelCompositeModelSummaries' => [ [ 'description' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', 'path' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'type' => '<string>', ], // ... ], 'assetModelCompositeModelType' => '<string>', 'assetModelId' => '<string>', 'compositionDetails' => [ 'compositionRelationship' => [ [ 'id' => '<string>', ], // ... ], ], ]
Result Details
Members
- actionDefinitions
-
- Type: Array of ActionDefinition structures
The available actions for a composite model on this asset model.
- assetModelCompositeModelDescription
-
- Required: Yes
- Type: string
The description for the composite model.
- assetModelCompositeModelExternalId
-
- Type: string
The external ID of a composite model on this asset model.
- assetModelCompositeModelId
-
- Required: Yes
- Type: string
The ID of a composite model on this asset model.
- assetModelCompositeModelName
-
- Required: Yes
- Type: string
The unique, friendly name for the composite model.
- assetModelCompositeModelPath
-
- Required: Yes
- Type: Array of AssetModelCompositeModelPathSegment structures
The path to the composite model listing the parent composite models.
- assetModelCompositeModelProperties
-
- Required: Yes
- Type: Array of AssetModelProperty structures
The property definitions of the composite model.
- assetModelCompositeModelSummaries
-
- Required: Yes
- Type: Array of AssetModelCompositeModelSummary structures
The list of composite model summaries for the composite model.
- assetModelCompositeModelType
-
- Required: Yes
- Type: string
The composite model type. Valid values are
AWS/ALARM
,CUSTOM
, orAWS/L4E_ANOMALY
. - assetModelId
-
- Required: Yes
- Type: string
The ID of the asset model, in UUID format.
- compositionDetails
-
- Type: CompositionDetails structure
Metadata for the composition relationship established by using
composedAssetModelId
inCreateAssetModelCompositeModel
. For instance, an array detailing the path of the composition relationship for this composite model.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeAssetProperty
$result = $client->describeAssetProperty
([/* ... */]); $promise = $client->describeAssetPropertyAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeAssetProperty([ 'assetId' => '<string>', // REQUIRED 'propertyId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- assetId
-
- Required: Yes
- Type: 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. - propertyId
-
- Required: Yes
- Type: 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.
Result Syntax
[ 'assetExternalId' => '<string>', 'assetId' => '<string>', 'assetModelId' => '<string>', 'assetName' => '<string>', 'assetProperty' => [ 'alias' => '<string>', 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', 'notification' => [ 'state' => 'ENABLED|DISABLED', 'topic' => '<string>', ], 'path' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'type' => [ 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ 'processingConfig' => [ 'forwardingConfig' => [ 'state' => 'DISABLED|ENABLED', ], ], ], 'metric' => [ 'expression' => '<string>', 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', ], 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], 'window' => [ 'tumbling' => [ 'interval' => '<string>', 'offset' => '<string>', ], ], ], 'transform' => [ 'expression' => '<string>', 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', 'forwardingConfig' => [ 'state' => 'DISABLED|ENABLED', ], ], 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], ], ], 'unit' => '<string>', ], 'compositeModel' => [ 'assetProperty' => [ 'alias' => '<string>', 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', 'notification' => [ 'state' => 'ENABLED|DISABLED', 'topic' => '<string>', ], 'path' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'type' => [ 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ 'processingConfig' => [ 'forwardingConfig' => [ 'state' => 'DISABLED|ENABLED', ], ], ], 'metric' => [ 'expression' => '<string>', 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', ], 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], 'window' => [ 'tumbling' => [ 'interval' => '<string>', 'offset' => '<string>', ], ], ], 'transform' => [ 'expression' => '<string>', 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', 'forwardingConfig' => [ 'state' => 'DISABLED|ENABLED', ], ], 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], ], ], 'unit' => '<string>', ], 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', 'type' => '<string>', ], ]
Result Details
Members
- assetExternalId
-
- Type: string
The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.
- assetId
-
- Required: Yes
- Type: string
The ID of the asset, in UUID format.
- assetModelId
-
- Required: Yes
- Type: string
The ID of the asset model, in UUID format.
- assetName
-
- Required: Yes
- Type: string
The name of the asset.
- assetProperty
-
- Type: Property structure
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
. - compositeModel
-
- Type: CompositeModelProperty structure
The composite model that declares this asset property, if this asset property exists in a composite model.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeBulkImportJob
$result = $client->describeBulkImportJob
([/* ... */]); $promise = $client->describeBulkImportJobAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeBulkImportJob([ 'jobId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- jobId
-
- Required: Yes
- Type: string
The ID of the job.
Result Syntax
[ 'adaptiveIngestion' => true || false, 'deleteFilesAfterImport' => true || false, 'errorReportLocation' => [ 'bucket' => '<string>', 'prefix' => '<string>', ], 'files' => [ [ 'bucket' => '<string>', 'key' => '<string>', 'versionId' => '<string>', ], // ... ], 'jobConfiguration' => [ 'fileFormat' => [ 'csv' => [ 'columnNames' => ['<string>', ...], ], 'parquet' => [ ], ], ], 'jobCreationDate' => <DateTime>, 'jobId' => '<string>', 'jobLastUpdateDate' => <DateTime>, 'jobName' => '<string>', 'jobRoleArn' => '<string>', 'jobStatus' => 'PENDING|CANCELLED|RUNNING|COMPLETED|FAILED|COMPLETED_WITH_FAILURES', ]
Result Details
Members
- adaptiveIngestion
-
- Type: boolean
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.
- deleteFilesAfterImport
-
- Type: boolean
If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.
- errorReportLocation
-
- Required: Yes
- Type: ErrorReportLocation structure
The Amazon S3 destination where errors associated with the job creation request are saved.
- files
-
- Required: Yes
- Type: Array of File structures
The files in the specified Amazon S3 bucket that contain your data.
- jobConfiguration
-
- Required: Yes
- Type: JobConfiguration structure
Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
- jobCreationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the job was created, in Unix epoch TIME.
- jobId
-
- Required: Yes
- Type: string
The ID of the job.
- jobLastUpdateDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the job was last updated, in Unix epoch time.
- jobName
-
- Required: Yes
- Type: string
The unique name that helps identify the job request.
- jobRoleArn
-
- Required: Yes
- Type: string
The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
- jobStatus
-
- Required: Yes
- Type: 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.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeDashboard
$result = $client->describeDashboard
([/* ... */]); $promise = $client->describeDashboardAsync
([/* ... */]);
Retrieves information about a dashboard.
Parameter Syntax
$result = $client->describeDashboard([ 'dashboardId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- dashboardId
-
- Required: Yes
- Type: string
The ID of the dashboard.
Result Syntax
[ 'dashboardArn' => '<string>', 'dashboardCreationDate' => <DateTime>, 'dashboardDefinition' => '<string>', 'dashboardDescription' => '<string>', 'dashboardId' => '<string>', 'dashboardLastUpdateDate' => <DateTime>, 'dashboardName' => '<string>', 'projectId' => '<string>', ]
Result Details
Members
- dashboardArn
-
- Required: Yes
- Type: string
The ARN of the dashboard, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
- dashboardCreationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the dashboard was created, in Unix epoch time.
- dashboardDefinition
-
- Required: Yes
- Type: string
The dashboard's definition JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide.
- dashboardDescription
-
- Type: string
The dashboard's description.
- dashboardId
-
- Required: Yes
- Type: string
The ID of the dashboard.
- dashboardLastUpdateDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the dashboard was last updated, in Unix epoch time.
- dashboardName
-
- Required: Yes
- Type: string
The name of the dashboard.
- projectId
-
- Required: Yes
- Type: string
The ID of the project that the dashboard is in.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeDataset
$result = $client->describeDataset
([/* ... */]); $promise = $client->describeDatasetAsync
([/* ... */]);
Retrieves information about a dataset.
Parameter Syntax
$result = $client->describeDataset([ 'datasetId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- datasetId
-
- Required: Yes
- Type: string
The ID of the dataset.
Result Syntax
[ 'datasetArn' => '<string>', 'datasetCreationDate' => <DateTime>, 'datasetDescription' => '<string>', 'datasetId' => '<string>', 'datasetLastUpdateDate' => <DateTime>, 'datasetName' => '<string>', 'datasetSource' => [ 'sourceDetail' => [ 'kendra' => [ 'knowledgeBaseArn' => '<string>', 'roleArn' => '<string>', ], ], 'sourceFormat' => 'KNOWLEDGE_BASE', 'sourceType' => 'KENDRA', ], 'datasetStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED', ], 'datasetVersion' => '<string>', ]
Result Details
Members
- datasetArn
-
- Required: Yes
- Type: string
The ARN of the dataset. The format is
arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}
. - datasetCreationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The dataset creation date, in Unix epoch time.
- datasetDescription
-
- Required: Yes
- Type: string
A description about the dataset, and its functionality.
- datasetId
-
- Required: Yes
- Type: string
The ID of the dataset.
- datasetLastUpdateDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the dataset was last updated, in Unix epoch time.
- datasetName
-
- Required: Yes
- Type: string
The name of the dataset.
- datasetSource
-
- Required: Yes
- Type: DatasetSource structure
The data source for the dataset.
- datasetStatus
-
- Required: Yes
- Type: DatasetStatus structure
The status of the dataset. This contains the state and any error messages. State is
CREATING
after a successfull call to this API, and any associated error message. The state isACTIVE
when ready to use. - datasetVersion
-
- Type: string
The version of the dataset.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeDefaultEncryptionConfiguration
$result = $client->describeDefaultEncryptionConfiguration
([/* ... */]); $promise = $client->describeDefaultEncryptionConfigurationAsync
([/* ... */]);
Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, see Key management in the IoT SiteWise User Guide.
Parameter Syntax
$result = $client->describeDefaultEncryptionConfiguration([ ]);
Parameter Details
Members
Result Syntax
[ 'configurationStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'message' => '<string>', ], 'state' => 'ACTIVE|UPDATE_IN_PROGRESS|UPDATE_FAILED', ], 'encryptionType' => 'SITEWISE_DEFAULT_ENCRYPTION|KMS_BASED_ENCRYPTION', 'kmsKeyArn' => '<string>', ]
Result Details
Members
- configurationStatus
-
- Required: Yes
- Type: ConfigurationStatus structure
The status of the account configuration. This contains the
ConfigurationState
. If there's an error, it also contains theErrorDetails
. - encryptionType
-
- Required: Yes
- Type: string
The type of encryption used for the encryption configuration.
- kmsKeyArn
-
- Type: string
The key ARN of the customer managed key used for KMS encryption if you use
KMS_BASED_ENCRYPTION
.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeGateway
$result = $client->describeGateway
([/* ... */]); $promise = $client->describeGatewayAsync
([/* ... */]);
Retrieves information about a gateway.
Parameter Syntax
$result = $client->describeGateway([ 'gatewayId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- gatewayId
-
- Required: Yes
- Type: string
The ID of the gateway device.
Result Syntax
[ 'creationDate' => <DateTime>, 'gatewayArn' => '<string>', 'gatewayCapabilitySummaries' => [ [ 'capabilityNamespace' => '<string>', 'capabilitySyncStatus' => 'IN_SYNC|OUT_OF_SYNC|SYNC_FAILED|UNKNOWN|NOT_APPLICABLE', ], // ... ], 'gatewayId' => '<string>', 'gatewayName' => '<string>', 'gatewayPlatform' => [ 'greengrass' => [ 'groupArn' => '<string>', ], 'greengrassV2' => [ 'coreDeviceThingName' => '<string>', ], 'siemensIE' => [ 'iotCoreThingName' => '<string>', ], ], 'lastUpdateDate' => <DateTime>, ]
Result Details
Members
- creationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the gateway was created, in Unix epoch time.
- gatewayArn
-
- Required: Yes
- Type: string
The ARN of the gateway, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
- gatewayCapabilitySummaries
-
- Required: Yes
- Type: Array of GatewayCapabilitySummary structures
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.
- gatewayId
-
- Required: Yes
- Type: string
The ID of the gateway device.
- gatewayName
-
- Required: Yes
- Type: string
The name of the gateway.
- gatewayPlatform
-
- Type: GatewayPlatform structure
The gateway's platform.
- lastUpdateDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the gateway was last updated, in Unix epoch time.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeGatewayCapabilityConfiguration
$result = $client->describeGatewayCapabilityConfiguration
([/* ... */]); $promise = $client->describeGatewayCapabilityConfigurationAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeGatewayCapabilityConfiguration([ 'capabilityNamespace' => '<string>', // REQUIRED 'gatewayId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- capabilityNamespace
-
- Required: Yes
- Type: string
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
, whereversion
is a number such as1
. - gatewayId
-
- Required: Yes
- Type: string
The ID of the gateway that defines the capability configuration.
Result Syntax
[ 'capabilityConfiguration' => '<string>', 'capabilityNamespace' => '<string>', 'capabilitySyncStatus' => 'IN_SYNC|OUT_OF_SYNC|SYNC_FAILED|UNKNOWN|NOT_APPLICABLE', 'gatewayId' => '<string>', ]
Result Details
Members
- capabilityConfiguration
-
- Required: Yes
- Type: string
The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.
- capabilityNamespace
-
- Required: Yes
- Type: string
The namespace of the gateway capability.
- capabilitySyncStatus
-
- Required: Yes
- Type: 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. -
NOT_APPLICABLE
– Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner. -
OUT_OF_SYNC
– The gateway hasn't received the capability configuration. -
SYNC_FAILED
– The gateway rejected the capability configuration. -
UNKNOWN
– The synchronization status is currently unknown due to an undetermined or temporary error.
- gatewayId
-
- Required: Yes
- Type: string
The ID of the gateway that defines the capability configuration.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeLoggingOptions
$result = $client->describeLoggingOptions
([/* ... */]); $promise = $client->describeLoggingOptionsAsync
([/* ... */]);
Retrieves the current IoT SiteWise logging options.
Parameter Syntax
$result = $client->describeLoggingOptions([ ]);
Parameter Details
Members
Result Syntax
[ 'loggingOptions' => [ 'level' => 'ERROR|INFO|OFF', ], ]
Result Details
Members
- loggingOptions
-
- Required: Yes
- Type: LoggingOptions structure
The current logging options.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ResourceNotFoundException:
The requested resource can't be found.
DescribePortal
$result = $client->describePortal
([/* ... */]); $promise = $client->describePortalAsync
([/* ... */]);
Retrieves information about a portal.
Parameter Syntax
$result = $client->describePortal([ 'portalId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- portalId
-
- Required: Yes
- Type: string
The ID of the portal.
Result Syntax
[ 'alarms' => [ 'alarmRoleArn' => '<string>', 'notificationLambdaArn' => '<string>', ], 'notificationSenderEmail' => '<string>', 'portalArn' => '<string>', 'portalAuthMode' => 'IAM|SSO', 'portalClientId' => '<string>', 'portalContactEmail' => '<string>', 'portalCreationDate' => <DateTime>, 'portalDescription' => '<string>', 'portalId' => '<string>', 'portalLastUpdateDate' => <DateTime>, 'portalLogoImageLocation' => [ 'id' => '<string>', 'url' => '<string>', ], 'portalName' => '<string>', 'portalStartUrl' => '<string>', 'portalStatus' => [ 'error' => [ 'code' => 'INTERNAL_FAILURE|VALIDATION_ERROR|LIMIT_EXCEEDED', 'message' => '<string>', ], 'state' => 'CREATING|PENDING|UPDATING|DELETING|ACTIVE|FAILED', ], 'portalType' => 'SITEWISE_PORTAL_V1|SITEWISE_PORTAL_V2', 'portalTypeConfiguration' => [ '<PortalTypeKey>' => [ 'portalTools' => ['<string>', ...], ], // ... ], 'roleArn' => '<string>', ]
Result Details
Members
- alarms
-
- Type: Alarms structure
Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
- notificationSenderEmail
-
- Type: string
The email address that sends alarm notifications.
- portalArn
-
- Required: Yes
- Type: string
The ARN of the portal, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
- portalAuthMode
-
- Type: string
The service to use to authenticate users to the portal.
- portalClientId
-
- Required: Yes
- Type: 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. - portalContactEmail
-
- Required: Yes
- Type: string
The Amazon Web Services administrator's contact email address.
- portalCreationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the portal was created, in Unix epoch time.
- portalDescription
-
- Type: string
The portal's description.
- portalId
-
- Required: Yes
- Type: string
The ID of the portal.
- portalLastUpdateDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the portal was last updated, in Unix epoch time.
- portalLogoImageLocation
-
- Type: ImageLocation structure
The portal's logo image, which is available at a URL.
- portalName
-
- Required: Yes
- Type: string
The name of the portal.
- portalStartUrl
-
- Required: Yes
- Type: 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.
- portalStatus
-
- Required: Yes
- Type: PortalStatus structure
The current status of the portal, which contains a state and any error message.
- portalType
-
- Type: string
Define the type of portal. The value for IoT SiteWise Monitor (Classic) is
SITEWISE_PORTAL_V1
. The value for IoT SiteWise Monitor (AI-aware) isSITEWISE_PORTAL_V2
. - portalTypeConfiguration
-
- Type: Associative array of custom strings keys (PortalTypeKey) to PortalTypeEntry structures
The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is
SITEWISE_PORTAL_V1
. The value for IoT SiteWise Monitor (AI-aware) isSITEWISE_PORTAL_V2
. - roleArn
-
- Type: string
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.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeProject
$result = $client->describeProject
([/* ... */]); $promise = $client->describeProjectAsync
([/* ... */]);
Retrieves information about a project.
Parameter Syntax
$result = $client->describeProject([ 'projectId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- projectId
-
- Required: Yes
- Type: string
The ID of the project.
Result Syntax
[ 'portalId' => '<string>', 'projectArn' => '<string>', 'projectCreationDate' => <DateTime>, 'projectDescription' => '<string>', 'projectId' => '<string>', 'projectLastUpdateDate' => <DateTime>, 'projectName' => '<string>', ]
Result Details
Members
- portalId
-
- Required: Yes
- Type: string
The ID of the portal that the project is in.
- projectArn
-
- Required: Yes
- Type: string
The ARN of the project, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
- projectCreationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the project was created, in Unix epoch time.
- projectDescription
-
- Type: string
The project's description.
- projectId
-
- Required: Yes
- Type: string
The ID of the project.
- projectLastUpdateDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the project was last updated, in Unix epoch time.
- projectName
-
- Required: Yes
- Type: string
The name of the project.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DescribeStorageConfiguration
$result = $client->describeStorageConfiguration
([/* ... */]); $promise = $client->describeStorageConfigurationAsync
([/* ... */]);
Retrieves information about the storage configuration for IoT SiteWise.
Parameter Syntax
$result = $client->describeStorageConfiguration([ ]);
Parameter Details
Members
Result Syntax
[ 'configurationStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'message' => '<string>', ], 'state' => 'ACTIVE|UPDATE_IN_PROGRESS|UPDATE_FAILED', ], 'disassociatedDataStorage' => 'ENABLED|DISABLED', 'lastUpdateDate' => <DateTime>, 'multiLayerStorage' => [ 'customerManagedS3Storage' => [ 'roleArn' => '<string>', 's3ResourceArn' => '<string>', ], ], 'retentionPeriod' => [ 'numberOfDays' => <integer>, 'unlimited' => true || false, ], 'storageType' => 'SITEWISE_DEFAULT_STORAGE|MULTI_LAYER_STORAGE', 'warmTier' => 'ENABLED|DISABLED', 'warmTierRetentionPeriod' => [ 'numberOfDays' => <integer>, 'unlimited' => true || false, ], ]
Result Details
Members
- configurationStatus
-
- Required: Yes
- Type: ConfigurationStatus structure
Contains current status information for the configuration.
- disassociatedDataStorage
-
- Type: string
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.
- lastUpdateDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the storage configuration was last updated, in Unix epoch time.
- multiLayerStorage
-
- Type: MultiLayerStorage structure
Contains information about the storage destination.
- retentionPeriod
-
- Type: RetentionPeriod structure
The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.
- storageType
-
- Required: Yes
- Type: string
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.
- warmTier
-
- Type: string
A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.
- warmTierRetentionPeriod
-
- Type: WarmTierRetentionPeriod structure
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.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
DescribeTimeSeries
$result = $client->describeTimeSeries
([/* ... */]); $promise = $client->describeTimeSeriesAsync
([/* ... */]);
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
andpropertyId
that identifies the asset property.
-
Parameter Syntax
$result = $client->describeTimeSeries([ 'alias' => '<string>', 'assetId' => '<string>', 'propertyId' => '<string>', ]);
Parameter Details
Members
- alias
-
- Type: string
The alias that identifies the time series.
- assetId
-
- Type: 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. - propertyId
-
- Type: 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.
Result Syntax
[ 'alias' => '<string>', 'assetId' => '<string>', 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', 'dataTypeSpec' => '<string>', 'propertyId' => '<string>', 'timeSeriesArn' => '<string>', 'timeSeriesCreationDate' => <DateTime>, 'timeSeriesId' => '<string>', 'timeSeriesLastUpdateDate' => <DateTime>, ]
Result Details
Members
- alias
-
- Type: string
The alias that identifies the time series.
- assetId
-
- Type: string
The ID of the asset in which the asset property was created.
- dataType
-
- Required: Yes
- Type: string
The data type of the time series.
If you specify
STRUCT
, you must also specifydataTypeSpec
to identify the type of the structure for this time series. - dataTypeSpec
-
- Type: 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. - propertyId
-
- Type: string
The ID of the asset property, in UUID format.
- timeSeriesArn
-
- Required: Yes
- Type: string
The ARN of the time series, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
- timeSeriesCreationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date that the time series was created, in Unix epoch time.
- timeSeriesId
-
- Required: Yes
- Type: string
The ID of the time series.
- timeSeriesLastUpdateDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date that the time series was last updated, in Unix epoch time.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
DisassociateAssets
$result = $client->disassociateAssets
([/* ... */]); $promise = $client->disassociateAssetsAsync
([/* ... */]);
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
Parameter Syntax
$result = $client->disassociateAssets([ 'assetId' => '<string>', // REQUIRED 'childAssetId' => '<string>', // REQUIRED 'clientToken' => '<string>', 'hierarchyId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- assetId
-
- Required: Yes
- Type: string
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. - childAssetId
-
- Required: Yes
- Type: 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. - clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- hierarchyId
-
- Required: Yes
- Type: 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.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
DisassociateTimeSeriesFromAssetProperty
$result = $client->disassociateTimeSeriesFromAssetProperty
([/* ... */]); $promise = $client->disassociateTimeSeriesFromAssetPropertyAsync
([/* ... */]);
Disassociates a time series (data stream) from an asset property.
Parameter Syntax
$result = $client->disassociateTimeSeriesFromAssetProperty([ 'alias' => '<string>', // REQUIRED 'assetId' => '<string>', // REQUIRED 'clientToken' => '<string>', 'propertyId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- alias
-
- Required: Yes
- Type: string
The alias that identifies the time series.
- assetId
-
- Required: Yes
- Type: 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. - clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- propertyId
-
- Required: Yes
- Type: 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.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
ExecuteAction
$result = $client->executeAction
([/* ... */]); $promise = $client->executeActionAsync
([/* ... */]);
Executes an action on a target resource.
Parameter Syntax
$result = $client->executeAction([ 'actionDefinitionId' => '<string>', // REQUIRED 'actionPayload' => [ // REQUIRED 'stringValue' => '<string>', // REQUIRED ], 'clientToken' => '<string>', 'targetResource' => [ // REQUIRED 'assetId' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- actionDefinitionId
-
- Required: Yes
- Type: string
The ID of the action definition.
- actionPayload
-
- Required: Yes
- Type: ActionPayload structure
The JSON payload of the action.
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- targetResource
-
- Required: Yes
- Type: TargetResource structure
The resource the action will be taken on.
Result Syntax
[ 'actionId' => '<string>', ]
Result Details
Members
- actionId
-
- Required: Yes
- Type: string
The ID of the action.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
ExecuteQuery
$result = $client->executeQuery
([/* ... */]); $promise = $client->executeQueryAsync
([/* ... */]);
Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.
Parameter Syntax
$result = $client->executeQuery([ 'clientToken' => '<string>', 'maxResults' => <integer>, 'nextToken' => '<string>', 'queryStatement' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- maxResults
-
- Type: int
The maximum number of results to return at one time. The default is 25.
- nextToken
-
- Type: string
The string that specifies the next page of results.
- queryStatement
-
- Required: Yes
- Type: string
The IoT SiteWise query statement.
Result Syntax
[ 'columns' => [ [ 'name' => '<string>', 'type' => [ 'scalarType' => 'BOOLEAN|INT|DOUBLE|TIMESTAMP|STRING', ], ], // ... ], 'nextToken' => '<string>', 'rows' => [ [ 'data' => [ [ 'arrayValue' => [...], // RECURSIVE 'nullValue' => true || false, 'rowValue' => [...], // RECURSIVE 'scalarValue' => '<string>', ], // ... ], ], // ... ], ]
Result Details
Members
- columns
-
- Type: Array of ColumnInfo structures
Represents a single column in the query results.
- nextToken
-
- Type: string
The string that specifies the next page of results.
- rows
-
- Type: Array of Row structures
Represents a single row in the query results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- AccessDeniedException:
Access is denied.
- ValidationException:
The validation failed for this query.
- QueryTimeoutException:
The query timed out.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ServiceUnavailableException:
The requested service is unavailable.
GetAssetPropertyAggregates
$result = $client->getAssetPropertyAggregates
([/* ... */]); $promise = $client->getAssetPropertyAggregatesAsync
([/* ... */]);
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
andpropertyId
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.
Parameter Syntax
$result = $client->getAssetPropertyAggregates([ 'aggregateTypes' => ['<string>', ...], // REQUIRED 'assetId' => '<string>', 'endDate' => <integer || string || DateTime>, // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'propertyAlias' => '<string>', 'propertyId' => '<string>', 'qualities' => ['<string>', ...], 'resolution' => '<string>', // REQUIRED 'startDate' => <integer || string || DateTime>, // REQUIRED 'timeOrdering' => 'ASCENDING|DESCENDING', ]);
Parameter Details
Members
- aggregateTypes
-
- Required: Yes
- Type: Array of strings
The data aggregating function.
- assetId
-
- Type: string
The ID of the asset, in UUID format.
- endDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
- maxResults
-
- Type: int
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 ofmaxResults
is 2500.
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
- propertyAlias
-
- Type: string
The alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. - propertyId
-
- Type: string
The ID of the asset property, in UUID format.
- qualities
-
- Type: Array of strings
The quality by which to filter asset data.
- resolution
-
- Required: Yes
- Type: string
The time interval over which to aggregate data.
- startDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
- timeOrdering
-
- Type: string
The chronological sorting order of the requested information.
Default:
ASCENDING
Result Syntax
[ 'aggregatedValues' => [ [ 'quality' => 'GOOD|BAD|UNCERTAIN', 'timestamp' => <DateTime>, 'value' => [ 'average' => <float>, 'count' => <float>, 'maximum' => <float>, 'minimum' => <float>, 'standardDeviation' => <float>, 'sum' => <float>, ], ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- aggregatedValues
-
- Required: Yes
- Type: Array of AggregatedValue structures
The requested aggregated values.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ServiceUnavailableException:
The requested service is unavailable.
GetAssetPropertyValue
$result = $client->getAssetPropertyValue
([/* ... */]); $promise = $client->getAssetPropertyValueAsync
([/* ... */]);
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
andpropertyId
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.
Parameter Syntax
$result = $client->getAssetPropertyValue([ 'assetId' => '<string>', 'propertyAlias' => '<string>', 'propertyId' => '<string>', ]);
Parameter Details
Members
- assetId
-
- Type: string
The ID of the asset, in UUID format.
- propertyAlias
-
- Type: string
The alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. - propertyId
-
- Type: string
The ID of the asset property, in UUID format.
Result Syntax
[ 'propertyValue' => [ 'quality' => 'GOOD|BAD|UNCERTAIN', 'timestamp' => [ 'offsetInNanos' => <integer>, 'timeInSeconds' => <integer>, ], 'value' => [ 'booleanValue' => true || false, 'doubleValue' => <float>, 'integerValue' => <integer>, 'stringValue' => '<string>', ], ], ]
Result Details
Members
- propertyValue
-
- Type: AssetPropertyValue structure
The current asset property value.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ServiceUnavailableException:
The requested service is unavailable.
GetAssetPropertyValueHistory
$result = $client->getAssetPropertyValueHistory
([/* ... */]); $promise = $client->getAssetPropertyValueHistoryAsync
([/* ... */]);
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
andpropertyId
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.
Parameter Syntax
$result = $client->getAssetPropertyValueHistory([ 'assetId' => '<string>', 'endDate' => <integer || string || DateTime>, 'maxResults' => <integer>, 'nextToken' => '<string>', 'propertyAlias' => '<string>', 'propertyId' => '<string>', 'qualities' => ['<string>', ...], 'startDate' => <integer || string || DateTime>, 'timeOrdering' => 'ASCENDING|DESCENDING', ]);
Parameter Details
Members
- assetId
-
- Type: string
The ID of the asset, in UUID format.
- endDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
- maxResults
-
- Type: int
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 ofmaxResults
is 20000.
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
- propertyAlias
-
- Type: string
The alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. - propertyId
-
- Type: string
The ID of the asset property, in UUID format.
- qualities
-
- Type: Array of strings
The quality by which to filter asset data.
- startDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
- timeOrdering
-
- Type: string
The chronological sorting order of the requested information.
Default:
ASCENDING
Result Syntax
[ 'assetPropertyValueHistory' => [ [ 'quality' => 'GOOD|BAD|UNCERTAIN', 'timestamp' => [ 'offsetInNanos' => <integer>, 'timeInSeconds' => <integer>, ], 'value' => [ 'booleanValue' => true || false, 'doubleValue' => <float>, 'integerValue' => <integer>, 'stringValue' => '<string>', ], ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- assetPropertyValueHistory
-
- Required: Yes
- Type: Array of AssetPropertyValue structures
The asset property's value history.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ServiceUnavailableException:
The requested service is unavailable.
GetInterpolatedAssetPropertyValues
$result = $client->getInterpolatedAssetPropertyValues
([/* ... */]); $promise = $client->getInterpolatedAssetPropertyValuesAsync
([/* ... */]);
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
andpropertyId
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.
Parameter Syntax
$result = $client->getInterpolatedAssetPropertyValues([ 'assetId' => '<string>', 'endTimeInSeconds' => <integer>, // REQUIRED 'endTimeOffsetInNanos' => <integer>, 'intervalInSeconds' => <integer>, // REQUIRED 'intervalWindowInSeconds' => <integer>, 'maxResults' => <integer>, 'nextToken' => '<string>', 'propertyAlias' => '<string>', 'propertyId' => '<string>', 'quality' => 'GOOD|BAD|UNCERTAIN', // REQUIRED 'startTimeInSeconds' => <integer>, // REQUIRED 'startTimeOffsetInNanos' => <integer>, 'type' => '<string>', // REQUIRED ]);
Parameter Details
Members
- assetId
-
- Type: string
The ID of the asset, in UUID format.
- endTimeInSeconds
-
- Required: Yes
- Type: long (int|float)
The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.
- endTimeOffsetInNanos
-
- Type: int
The nanosecond offset converted from
endTimeInSeconds
. - intervalInSeconds
-
- Required: Yes
- Type: long (int|float)
The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends.
- intervalWindowInSeconds
-
- Type: long (int|float)
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 thetype
parameter must beLINEAR_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.
- maxResults
-
- Type: int
The maximum number of results to return for each paginated request. If not specified, the default value is 10.
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
- propertyAlias
-
- Type: string
The alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. - propertyId
-
- Type: string
The ID of the asset property, in UUID format.
- quality
-
- Required: Yes
- Type: string
The quality of the asset property value. You can use this parameter as a filter to choose only the asset property values that have a specific quality.
- startTimeInSeconds
-
- Required: Yes
- Type: long (int|float)
The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.
- startTimeOffsetInNanos
-
- Type: int
The nanosecond offset converted from
startTimeInSeconds
. - type
-
- Required: Yes
- Type: string
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 interpolationIf 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.
Result Syntax
[ 'interpolatedAssetPropertyValues' => [ [ 'timestamp' => [ 'offsetInNanos' => <integer>, 'timeInSeconds' => <integer>, ], 'value' => [ 'booleanValue' => true || false, 'doubleValue' => <float>, 'integerValue' => <integer>, 'stringValue' => '<string>', ], ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- interpolatedAssetPropertyValues
-
- Required: Yes
- Type: Array of InterpolatedAssetPropertyValue structures
The requested interpolated values.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ServiceUnavailableException:
The requested service is unavailable.
InvokeAssistant
$result = $client->invokeAssistant
([/* ... */]); $promise = $client->invokeAssistantAsync
([/* ... */]);
Invokes SiteWise Assistant to start or continue a conversation.
Parameter Syntax
$result = $client->invokeAssistant([ 'conversationId' => '<string>', 'enableTrace' => true || false, 'message' => '<string>', // REQUIRED ]);
Parameter Details
Members
- conversationId
-
- Type: string
The ID assigned to a conversation. IoT SiteWise automatically generates a unique ID for you, and this parameter is never required. However, if you prefer to have your own ID, you must specify it here in UUID format. If you specify your own ID, it must be globally unique.
- enableTrace
-
- Type: boolean
Specifies if to turn trace on or not. It is used to track the SiteWise Assistant's reasoning, and data access process.
- message
-
- Required: Yes
- Type: string
A text message sent to the SiteWise Assistant by the user.
Result Syntax
[ 'body' => [ // EventParsingIterator 'accessDeniedException' => [ 'message' => '<string>', ], 'conflictingOperationException' => [ 'message' => '<string>', 'resourceArn' => '<string>', 'resourceId' => '<string>', ], 'internalFailureException' => [ 'message' => '<string>', ], 'invalidRequestException' => [ 'message' => '<string>', ], 'limitExceededException' => [ 'message' => '<string>', ], 'output' => [ 'citations' => [ [ 'content' => [ 'text' => '<string>', ], 'reference' => [ 'dataset' => [ 'datasetArn' => '<string>', 'source' => [ 'arn' => '<string>', 'location' => [ 'uri' => '<string>', ], ], ], ], ], // ... ], 'message' => '<string>', ], 'resourceNotFoundException' => [ 'message' => '<string>', ], 'throttlingException' => [ 'message' => '<string>', ], 'trace' => [ 'text' => '<string>', ], ], 'conversationId' => '<string>', ]
Result Details
Members
- body
-
- Required: Yes
- Type: EventParsingIterator supplying the following structures: Trace, InvocationOutput, AccessDeniedException, ConflictingOperationException, InternalFailureException, InvalidRequestException, LimitExceededException, ResourceNotFoundException, ThrottlingException
Contains the response, citation, and trace from the SiteWise Assistant.
- conversationId
-
- Required: Yes
- Type: string
The ID of the conversation, in UUID format. This ID uniquely identifies the conversation within IoT SiteWise.
Using an EventParsingIterator
To use an EventParsingIterator, you will need to loop over the events it will generate and check the top-level field to determine which type of event it is.
foreach($result['body'] as $event) { if (isset($event['accessDeniedException'])) { // Handle the 'accessDeniedException' event. } else if (isset($event['conflictingOperationException'])) { // Handle the 'conflictingOperationException' event. } else if (isset($event['internalFailureException'])) { // Handle the 'internalFailureException' event. } else if (isset($event['invalidRequestException'])) { // Handle the 'invalidRequestException' event. } else if (isset($event['limitExceededException'])) { // Handle the 'limitExceededException' event. } else if (isset($event['output'])) { // Handle the 'output' event. } else if (isset($event['resourceNotFoundException'])) { // Handle the 'resourceNotFoundException' event. } else if (isset($event['throttlingException'])) { // Handle the 'throttlingException' event. } else if (isset($event['trace'])) { // Handle the 'trace' event. } }
Errors
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- AccessDeniedException:
Access is denied.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ResourceNotFoundException:
The requested resource can't be found.
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
ListAccessPolicies
$result = $client->listAccessPolicies
([/* ... */]); $promise = $client->listAccessPoliciesAsync
([/* ... */]);
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).
Parameter Syntax
$result = $client->listAccessPolicies([ 'iamArn' => '<string>', 'identityId' => '<string>', 'identityType' => 'USER|GROUP|IAM', 'maxResults' => <integer>, 'nextToken' => '<string>', 'resourceId' => '<string>', 'resourceType' => 'PORTAL|PROJECT', ]);
Parameter Details
Members
- iamArn
-
- Type: string
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
foridentityType
. - identityId
-
- Type: string
The ID of the identity. This parameter is required if you specify
USER
orGROUP
foridentityType
. - identityType
-
- Type: string
The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required if you specify
identityId
. - maxResults
-
- Type: int
The maximum number of results to return for each paginated request.
Default: 50
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
- resourceId
-
- Type: string
The ID of the resource. This parameter is required if you specify
resourceType
. - resourceType
-
- Type: string
The type of resource (portal or project). This parameter is required if you specify
resourceId
.
Result Syntax
[ 'accessPolicySummaries' => [ [ 'creationDate' => <DateTime>, 'id' => '<string>', 'identity' => [ 'group' => [ 'id' => '<string>', ], 'iamRole' => [ 'arn' => '<string>', ], 'iamUser' => [ 'arn' => '<string>', ], 'user' => [ 'id' => '<string>', ], ], 'lastUpdateDate' => <DateTime>, 'permission' => 'ADMINISTRATOR|VIEWER', 'resource' => [ 'portal' => [ 'id' => '<string>', ], 'project' => [ 'id' => '<string>', ], ], ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- accessPolicySummaries
-
- Required: Yes
- Type: Array of AccessPolicySummary structures
A list that summarizes each access policy.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListActions
$result = $client->listActions
([/* ... */]); $promise = $client->listActionsAsync
([/* ... */]);
Retrieves a paginated list of actions for a specific target resource.
Parameter Syntax
$result = $client->listActions([ 'maxResults' => <integer>, 'nextToken' => '<string>', 'targetResourceId' => '<string>', // REQUIRED 'targetResourceType' => 'ASSET', // REQUIRED ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return for each paginated request.
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
- targetResourceId
-
- Required: Yes
- Type: string
The ID of the target resource.
- targetResourceType
-
- Required: Yes
- Type: string
The type of resource.
Result Syntax
[ 'actionSummaries' => [ [ 'actionDefinitionId' => '<string>', 'actionId' => '<string>', 'targetResource' => [ 'assetId' => '<string>', ], ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- actionSummaries
-
- Required: Yes
- Type: Array of ActionSummary structures
A list that summarizes the actions associated with the specified asset.
- nextToken
-
- Required: Yes
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ResourceNotFoundException:
The requested resource can't be found.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListAssetModelCompositeModels
$result = $client->listAssetModelCompositeModels
([/* ... */]); $promise = $client->listAssetModelCompositeModelsAsync
([/* ... */]);
Retrieves a paginated list of composite models associated with the asset model
Parameter Syntax
$result = $client->listAssetModelCompositeModels([ 'assetModelId' => '<string>', // REQUIRED 'assetModelVersion' => '<string>', 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- assetModelId
-
- Required: Yes
- Type: 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. - assetModelVersion
-
- Type: 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. - maxResults
-
- Type: int
The maximum number of results to return for each paginated request.
Default: 50
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
Result Syntax
[ 'assetModelCompositeModelSummaries' => [ [ 'description' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', 'path' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'type' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- assetModelCompositeModelSummaries
-
- Required: Yes
- Type: Array of AssetModelCompositeModelSummary structures
A list that summarizes each composite model.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ResourceNotFoundException:
The requested resource can't be found.
ListAssetModelProperties
$result = $client->listAssetModelProperties
([/* ... */]); $promise = $client->listAssetModelPropertiesAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listAssetModelProperties([ 'assetModelId' => '<string>', // REQUIRED 'assetModelVersion' => '<string>', 'filter' => 'ALL|BASE', 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- assetModelId
-
- Required: Yes
- Type: 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. - assetModelVersion
-
- Type: 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. - filter
-
- Type: 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
- maxResults
-
- Type: int
The maximum number of results to return for each paginated request. If not specified, the default value is 50.
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
Result Syntax
[ 'assetModelPropertySummaries' => [ [ 'assetModelCompositeModelId' => '<string>', 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', 'dataTypeSpec' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', 'path' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'type' => [ 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ 'processingConfig' => [ 'forwardingConfig' => [ 'state' => 'DISABLED|ENABLED', ], ], ], 'metric' => [ 'expression' => '<string>', 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', ], 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], 'window' => [ 'tumbling' => [ 'interval' => '<string>', 'offset' => '<string>', ], ], ], 'transform' => [ 'expression' => '<string>', 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', 'forwardingConfig' => [ 'state' => 'DISABLED|ENABLED', ], ], 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], ], ], 'unit' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- assetModelPropertySummaries
-
- Required: Yes
- Type: Array of AssetModelPropertySummary structures
A list that summarizes the properties associated with the specified asset model.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ResourceNotFoundException:
The requested resource can't be found.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListAssetModels
$result = $client->listAssetModels
([/* ... */]); $promise = $client->listAssetModelsAsync
([/* ... */]);
Retrieves a paginated list of summaries of all asset models.
Parameter Syntax
$result = $client->listAssetModels([ 'assetModelTypes' => ['<string>', ...], 'assetModelVersion' => '<string>', 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- assetModelTypes
-
- Type: Array of strings
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.
- assetModelVersion
-
- Type: 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. - maxResults
-
- Type: int
The maximum number of results to return for each paginated request.
Default: 50
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
Result Syntax
[ 'assetModelSummaries' => [ [ 'arn' => '<string>', 'assetModelType' => 'ASSET_MODEL|COMPONENT_MODEL', 'creationDate' => <DateTime>, 'description' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'lastUpdateDate' => <DateTime>, 'name' => '<string>', 'status' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|PROPAGATING|DELETING|FAILED', ], 'version' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- assetModelSummaries
-
- Required: Yes
- Type: Array of AssetModelSummary structures
A list that summarizes each asset model.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListAssetProperties
$result = $client->listAssetProperties
([/* ... */]); $promise = $client->listAssetPropertiesAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listAssetProperties([ 'assetId' => '<string>', // REQUIRED 'filter' => 'ALL|BASE', 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- assetId
-
- Required: Yes
- Type: 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. - filter
-
- Type: 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
- maxResults
-
- Type: int
The maximum number of results to return for each paginated request. If not specified, the default value is 50.
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
Result Syntax
[ 'assetPropertySummaries' => [ [ 'alias' => '<string>', 'assetCompositeModelId' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'notification' => [ 'state' => 'ENABLED|DISABLED', 'topic' => '<string>', ], 'path' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'unit' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- assetPropertySummaries
-
- Required: Yes
- Type: Array of AssetPropertySummary structures
A list that summarizes the properties associated with the specified asset.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ResourceNotFoundException:
The requested resource can't be found.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListAssetRelationships
$result = $client->listAssetRelationships
([/* ... */]); $promise = $client->listAssetRelationshipsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listAssetRelationships([ 'assetId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'traversalType' => 'PATH_TO_ROOT', // REQUIRED ]);
Parameter Details
Members
- assetId
-
- Required: Yes
- Type: 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. - maxResults
-
- Type: int
The maximum number of results to return for each paginated request.
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
- traversalType
-
- Required: Yes
- Type: 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 inassetId
is the first result in the list ofassetRelationshipSummaries
, and the root asset is the last result.
Result Syntax
[ 'assetRelationshipSummaries' => [ [ 'hierarchyInfo' => [ 'childAssetId' => '<string>', 'parentAssetId' => '<string>', ], 'relationshipType' => 'HIERARCHY', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- assetRelationshipSummaries
-
- Required: Yes
- Type: Array of AssetRelationshipSummary structures
A list that summarizes each asset relationship.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ResourceNotFoundException:
The requested resource can't be found.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListAssets
$result = $client->listAssets
([/* ... */]); $promise = $client->listAssetsAsync
([/* ... */]);
Retrieves a paginated list of asset summaries.
You can use this operation to do the following:
-
List assets based on a specific asset model.
-
List top-level assets.
You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.
Parameter Syntax
$result = $client->listAssets([ 'assetModelId' => '<string>', 'filter' => 'ALL|TOP_LEVEL', 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- assetModelId
-
- Type: string
The ID of the asset model by which to filter the list of assets. This parameter is required if you choose
ALL
forfilter
. This can be either the actual ID in UUID format, or elseexternalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide. - filter
-
- Type: 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. TheassetModelId
parameter is required if you filter byALL
. -
TOP_LEVEL
– The list includes only top-level assets in the asset hierarchy tree.
Default:
ALL
- maxResults
-
- Type: int
The maximum number of results to return for each paginated request.
Default: 50
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
Result Syntax
[ 'assetSummaries' => [ [ 'arn' => '<string>', 'assetModelId' => '<string>', 'creationDate' => <DateTime>, 'description' => '<string>', 'externalId' => '<string>', 'hierarchies' => [ [ 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', ], // ... ], 'id' => '<string>', 'lastUpdateDate' => <DateTime>, 'name' => '<string>', 'status' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED', ], ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- assetSummaries
-
- Required: Yes
- Type: Array of AssetSummary structures
A list that summarizes each asset.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ResourceNotFoundException:
The requested resource can't be found.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListAssociatedAssets
$result = $client->listAssociatedAssets
([/* ... */]); $promise = $client->listAssociatedAssetsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listAssociatedAssets([ 'assetId' => '<string>', // REQUIRED 'hierarchyId' => '<string>', 'maxResults' => <integer>, 'nextToken' => '<string>', 'traversalDirection' => 'PARENT|CHILD', ]);
Parameter Details
Members
- assetId
-
- Required: Yes
- Type: string
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. - hierarchyId
-
- Type: string
(Optional) If you don't provide a
hierarchyId
, all the immediate assets in thetraversalDirection
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.
- maxResults
-
- Type: int
The maximum number of results to return for each paginated request.
Default: 50
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
- traversalDirection
-
- Type: 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
Result Syntax
[ 'assetSummaries' => [ [ 'arn' => '<string>', 'assetModelId' => '<string>', 'creationDate' => <DateTime>, 'description' => '<string>', 'externalId' => '<string>', 'hierarchies' => [ [ 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', ], // ... ], 'id' => '<string>', 'lastUpdateDate' => <DateTime>, 'name' => '<string>', 'status' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED', ], ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- assetSummaries
-
- Required: Yes
- Type: Array of AssociatedAssetsSummary structures
A list that summarizes the associated assets.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ResourceNotFoundException:
The requested resource can't be found.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListBulkImportJobs
$result = $client->listBulkImportJobs
([/* ... */]); $promise = $client->listBulkImportJobsAsync
([/* ... */]);
Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.
Parameter Syntax
$result = $client->listBulkImportJobs([ 'filter' => 'ALL|PENDING|RUNNING|CANCELLED|FAILED|COMPLETED_WITH_FAILURES|COMPLETED', 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- filter
-
- Type: string
You can use a filter to select the bulk import jobs that you want to retrieve.
- maxResults
-
- Type: int
The maximum number of results to return for each paginated request.
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
Result Syntax
[ 'jobSummaries' => [ [ 'id' => '<string>', 'name' => '<string>', 'status' => 'PENDING|CANCELLED|RUNNING|COMPLETED|FAILED|COMPLETED_WITH_FAILURES', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- jobSummaries
-
- Required: Yes
- Type: Array of JobSummary structures
One or more job summaries to list.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ResourceNotFoundException:
The requested resource can't be found.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListCompositionRelationships
$result = $client->listCompositionRelationships
([/* ... */]); $promise = $client->listCompositionRelationshipsAsync
([/* ... */]);
Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL
.
Parameter Syntax
$result = $client->listCompositionRelationships([ 'assetModelId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- assetModelId
-
- Required: Yes
- Type: 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. - maxResults
-
- Type: int
The maximum number of results to return for each paginated request.
Default: 50
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
Result Syntax
[ 'compositionRelationshipSummaries' => [ [ 'assetModelCompositeModelId' => '<string>', 'assetModelCompositeModelType' => '<string>', 'assetModelId' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- compositionRelationshipSummaries
-
- Required: Yes
- Type: Array of CompositionRelationshipSummary structures
A list that summarizes each composition relationship.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ResourceNotFoundException:
The requested resource can't be found.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListDashboards
$result = $client->listDashboards
([/* ... */]); $promise = $client->listDashboardsAsync
([/* ... */]);
Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
Parameter Syntax
$result = $client->listDashboards([ 'maxResults' => <integer>, 'nextToken' => '<string>', 'projectId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return for each paginated request.
Default: 50
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
- projectId
-
- Required: Yes
- Type: string
The ID of the project.
Result Syntax
[ 'dashboardSummaries' => [ [ 'creationDate' => <DateTime>, 'description' => '<string>', 'id' => '<string>', 'lastUpdateDate' => <DateTime>, 'name' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- dashboardSummaries
-
- Required: Yes
- Type: Array of DashboardSummary structures
A list that summarizes each dashboard in the project.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListDatasets
$result = $client->listDatasets
([/* ... */]); $promise = $client->listDatasetsAsync
([/* ... */]);
Retrieves a paginated list of datasets for a specific target resource.
Parameter Syntax
$result = $client->listDatasets([ 'maxResults' => <integer>, 'nextToken' => '<string>', 'sourceType' => 'KENDRA', // REQUIRED ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return for each paginated request.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
- sourceType
-
- Required: Yes
- Type: string
The type of data source for the dataset.
Result Syntax
[ 'datasetSummaries' => [ [ 'arn' => '<string>', 'creationDate' => <DateTime>, 'description' => '<string>', 'id' => '<string>', 'lastUpdateDate' => <DateTime>, 'name' => '<string>', 'status' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED', ], ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- datasetSummaries
-
- Required: Yes
- Type: Array of DatasetSummary structures
A list that summarizes the dataset response.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListGateways
$result = $client->listGateways
([/* ... */]); $promise = $client->listGatewaysAsync
([/* ... */]);
Retrieves a paginated list of gateways.
Parameter Syntax
$result = $client->listGateways([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return for each paginated request.
Default: 50
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
Result Syntax
[ 'gatewaySummaries' => [ [ 'creationDate' => <DateTime>, 'gatewayCapabilitySummaries' => [ [ 'capabilityNamespace' => '<string>', 'capabilitySyncStatus' => 'IN_SYNC|OUT_OF_SYNC|SYNC_FAILED|UNKNOWN|NOT_APPLICABLE', ], // ... ], 'gatewayId' => '<string>', 'gatewayName' => '<string>', 'gatewayPlatform' => [ 'greengrass' => [ 'groupArn' => '<string>', ], 'greengrassV2' => [ 'coreDeviceThingName' => '<string>', ], 'siemensIE' => [ 'iotCoreThingName' => '<string>', ], ], 'lastUpdateDate' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- gatewaySummaries
-
- Required: Yes
- Type: Array of GatewaySummary structures
A list that summarizes each gateway.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListPortals
$result = $client->listPortals
([/* ... */]); $promise = $client->listPortalsAsync
([/* ... */]);
Retrieves a paginated list of IoT SiteWise Monitor portals.
Parameter Syntax
$result = $client->listPortals([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return for each paginated request.
Default: 50
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
Result Syntax
[ 'nextToken' => '<string>', 'portalSummaries' => [ [ 'creationDate' => <DateTime>, 'description' => '<string>', 'id' => '<string>', 'lastUpdateDate' => <DateTime>, 'name' => '<string>', 'portalType' => 'SITEWISE_PORTAL_V1|SITEWISE_PORTAL_V2', 'roleArn' => '<string>', 'startUrl' => '<string>', 'status' => [ 'error' => [ 'code' => 'INTERNAL_FAILURE|VALIDATION_ERROR|LIMIT_EXCEEDED', 'message' => '<string>', ], 'state' => 'CREATING|PENDING|UPDATING|DELETING|ACTIVE|FAILED', ], ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
- portalSummaries
-
- Type: Array of PortalSummary structures
A list that summarizes each portal.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListProjectAssets
$result = $client->listProjectAssets
([/* ... */]); $promise = $client->listProjectAssetsAsync
([/* ... */]);
Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
Parameter Syntax
$result = $client->listProjectAssets([ 'maxResults' => <integer>, 'nextToken' => '<string>', 'projectId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return for each paginated request.
Default: 50
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
- projectId
-
- Required: Yes
- Type: string
The ID of the project.
Result Syntax
[ 'assetIds' => ['<string>', ...], 'nextToken' => '<string>', ]
Result Details
Members
- assetIds
-
- Required: Yes
- Type: Array of strings
A list that contains the IDs of each asset associated with the project.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListProjects
$result = $client->listProjects
([/* ... */]); $promise = $client->listProjectsAsync
([/* ... */]);
Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
Parameter Syntax
$result = $client->listProjects([ 'maxResults' => <integer>, 'nextToken' => '<string>', 'portalId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return for each paginated request.
Default: 50
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
- portalId
-
- Required: Yes
- Type: string
The ID of the portal.
Result Syntax
[ 'nextToken' => '<string>', 'projectSummaries' => [ [ 'creationDate' => <DateTime>, 'description' => '<string>', 'id' => '<string>', 'lastUpdateDate' => <DateTime>, 'name' => '<string>', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
- projectSummaries
-
- Required: Yes
- Type: Array of ProjectSummary structures
A list that summarizes each project in the portal.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Retrieves the list of tags for an IoT SiteWise resource.
Parameter Syntax
$result = $client->listTagsForResource([ 'resourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource.
Result Syntax
[ 'tags' => ['<string>', ...], ]
Result Details
Members
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
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.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ResourceNotFoundException:
The requested resource can't be found.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
- UnauthorizedException:
You are not authorized.
ListTimeSeries
$result = $client->listTimeSeries
([/* ... */]); $promise = $client->listTimeSeriesAsync
([/* ... */]);
Retrieves a paginated list of time series (data streams).
Parameter Syntax
$result = $client->listTimeSeries([ 'aliasPrefix' => '<string>', 'assetId' => '<string>', 'maxResults' => <integer>, 'nextToken' => '<string>', 'timeSeriesType' => 'ASSOCIATED|DISASSOCIATED', ]);
Parameter Details
Members
- aliasPrefix
-
- Type: string
The alias prefix of the time series.
- assetId
-
- Type: 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. - maxResults
-
- Type: int
The maximum number of results to return for each paginated request.
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
- timeSeriesType
-
- Type: 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.
Result Syntax
[ 'TimeSeriesSummaries' => [ [ 'alias' => '<string>', 'assetId' => '<string>', 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', 'dataTypeSpec' => '<string>', 'propertyId' => '<string>', 'timeSeriesArn' => '<string>', 'timeSeriesCreationDate' => <DateTime>, 'timeSeriesId' => '<string>', 'timeSeriesLastUpdateDate' => <DateTime>, ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- TimeSeriesSummaries
-
- Required: Yes
- Type: Array of TimeSeriesSummary structures
One or more time series summaries to list.
- nextToken
-
- Type: string
The token for the next set of results, or null if there are no additional results.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
PutDefaultEncryptionConfiguration
$result = $client->putDefaultEncryptionConfiguration
([/* ... */]); $promise = $client->putDefaultEncryptionConfigurationAsync
([/* ... */]);
Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide.
Parameter Syntax
$result = $client->putDefaultEncryptionConfiguration([ 'encryptionType' => 'SITEWISE_DEFAULT_ENCRYPTION|KMS_BASED_ENCRYPTION', // REQUIRED 'kmsKeyId' => '<string>', ]);
Parameter Details
Members
- encryptionType
-
- Required: Yes
- Type: string
The type of encryption used for the encryption configuration.
- kmsKeyId
-
- Type: string
The Key ID of the customer managed key used for KMS encryption. This is required if you use
KMS_BASED_ENCRYPTION
.
Result Syntax
[ 'configurationStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'message' => '<string>', ], 'state' => 'ACTIVE|UPDATE_IN_PROGRESS|UPDATE_FAILED', ], 'encryptionType' => 'SITEWISE_DEFAULT_ENCRYPTION|KMS_BASED_ENCRYPTION', 'kmsKeyArn' => '<string>', ]
Result Details
Members
- configurationStatus
-
- Required: Yes
- Type: ConfigurationStatus structure
The status of the account configuration. This contains the
ConfigurationState
. If there is an error, it also contains theErrorDetails
. - encryptionType
-
- Required: Yes
- Type: string
The type of encryption used for the encryption configuration.
- kmsKeyArn
-
- Type: string
The Key ARN of the KMS key used for KMS encryption if you use
KMS_BASED_ENCRYPTION
.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
PutLoggingOptions
$result = $client->putLoggingOptions
([/* ... */]); $promise = $client->putLoggingOptionsAsync
([/* ... */]);
Sets logging options for IoT SiteWise.
Parameter Syntax
$result = $client->putLoggingOptions([ 'loggingOptions' => [ // REQUIRED 'level' => 'ERROR|INFO|OFF', // REQUIRED ], ]);
Parameter Details
Members
- loggingOptions
-
- Required: Yes
- Type: LoggingOptions structure
The logging options to set.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
- ResourceNotFoundException:
The requested resource can't be found.
PutStorageConfiguration
$result = $client->putStorageConfiguration
([/* ... */]); $promise = $client->putStorageConfigurationAsync
([/* ... */]);
Configures storage settings for IoT SiteWise.
Parameter Syntax
$result = $client->putStorageConfiguration([ 'disassociatedDataStorage' => 'ENABLED|DISABLED', 'multiLayerStorage' => [ 'customerManagedS3Storage' => [ // REQUIRED 'roleArn' => '<string>', // REQUIRED 's3ResourceArn' => '<string>', // REQUIRED ], ], 'retentionPeriod' => [ 'numberOfDays' => <integer>, 'unlimited' => true || false, ], 'storageType' => 'SITEWISE_DEFAULT_STORAGE|MULTI_LAYER_STORAGE', // REQUIRED 'warmTier' => 'ENABLED|DISABLED', 'warmTierRetentionPeriod' => [ 'numberOfDays' => <integer>, 'unlimited' => true || false, ], ]);
Parameter Details
Members
- disassociatedDataStorage
-
- Type: string
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.
- multiLayerStorage
-
- Type: MultiLayerStorage structure
Identifies a storage destination. If you specified
MULTI_LAYER_STORAGE
for the storage type, you must specify aMultiLayerStorage
object. - retentionPeriod
-
- Type: RetentionPeriod structure
The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.
- storageType
-
- Required: Yes
- Type: string
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.
- warmTier
-
- Type: string
A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.
- warmTierRetentionPeriod
-
- Type: WarmTierRetentionPeriod structure
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.
Result Syntax
[ 'configurationStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'message' => '<string>', ], 'state' => 'ACTIVE|UPDATE_IN_PROGRESS|UPDATE_FAILED', ], 'disassociatedDataStorage' => 'ENABLED|DISABLED', 'multiLayerStorage' => [ 'customerManagedS3Storage' => [ 'roleArn' => '<string>', 's3ResourceArn' => '<string>', ], ], 'retentionPeriod' => [ 'numberOfDays' => <integer>, 'unlimited' => true || false, ], 'storageType' => 'SITEWISE_DEFAULT_STORAGE|MULTI_LAYER_STORAGE', 'warmTier' => 'ENABLED|DISABLED', 'warmTierRetentionPeriod' => [ 'numberOfDays' => <integer>, 'unlimited' => true || false, ], ]
Result Details
Members
- configurationStatus
-
- Required: Yes
- Type: ConfigurationStatus structure
Contains current status information for the configuration.
- disassociatedDataStorage
-
- Type: string
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.
- multiLayerStorage
-
- Type: MultiLayerStorage structure
Contains information about the storage destination.
- retentionPeriod
-
- Type: RetentionPeriod structure
The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.
- storageType
-
- Required: Yes
- Type: string
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.
- warmTier
-
- Type: string
A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.
- warmTierRetentionPeriod
-
- Type: WarmTierRetentionPeriod structure
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.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceAlreadyExistsException:
The resource already exists.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
Parameter Syntax
$result = $client->tagResource([ 'resourceArn' => '<string>', // REQUIRED 'tags' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource to tag.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
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.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ResourceNotFoundException:
The requested resource can't be found.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
- UnauthorizedException:
You are not authorized.
- TooManyTagsException:
You've reached the limit for the number of tags allowed for a resource. For more information, see Tag naming limits and requirements in the Amazon Web Services General Reference.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes a tag from an IoT SiteWise resource.
Parameter Syntax
$result = $client->untagResource([ 'resourceArn' => '<string>', // REQUIRED 'tagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource to untag.
- tagKeys
-
- Required: Yes
- Type: Array of strings
A list of keys for tags to remove from the resource.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ResourceNotFoundException:
The requested resource can't be found.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
- UnauthorizedException:
You are not authorized.
UpdateAccessPolicy
$result = $client->updateAccessPolicy
([/* ... */]); $promise = $client->updateAccessPolicyAsync
([/* ... */]);
Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
Parameter Syntax
$result = $client->updateAccessPolicy([ 'accessPolicyId' => '<string>', // REQUIRED 'accessPolicyIdentity' => [ // REQUIRED 'group' => [ 'id' => '<string>', // REQUIRED ], 'iamRole' => [ 'arn' => '<string>', // REQUIRED ], 'iamUser' => [ 'arn' => '<string>', // REQUIRED ], 'user' => [ 'id' => '<string>', // REQUIRED ], ], 'accessPolicyPermission' => 'ADMINISTRATOR|VIEWER', // REQUIRED 'accessPolicyResource' => [ // REQUIRED 'portal' => [ 'id' => '<string>', // REQUIRED ], 'project' => [ 'id' => '<string>', // REQUIRED ], ], 'clientToken' => '<string>', ]);
Parameter Details
Members
- accessPolicyId
-
- Required: Yes
- Type: string
The ID of the access policy.
- accessPolicyIdentity
-
- Required: Yes
- Type: Identity structure
The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.
- accessPolicyPermission
-
- Required: Yes
- Type: string
The permission level for this access policy. Note that a project
ADMINISTRATOR
is also known as a project owner. - accessPolicyResource
-
- Required: Yes
- Type: Resource structure
The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
UpdateAsset
$result = $client->updateAsset
([/* ... */]); $promise = $client->updateAssetAsync
([/* ... */]);
Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.
Parameter Syntax
$result = $client->updateAsset([ 'assetDescription' => '<string>', 'assetExternalId' => '<string>', 'assetId' => '<string>', // REQUIRED 'assetName' => '<string>', // REQUIRED 'clientToken' => '<string>', ]);
Parameter Details
Members
- assetDescription
-
- Type: string
A description for the asset.
- assetExternalId
-
- Type: 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.
- assetId
-
- Required: Yes
- Type: string
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. - assetName
-
- Required: Yes
- Type: string
A friendly name for the asset.
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
Result Syntax
[ 'assetStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED', ], ]
Result Details
Members
- assetStatus
-
- Required: Yes
- Type: AssetStatus structure
The status of the asset, which contains a state (
UPDATING
after successfully calling this operation) and any error message.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceAlreadyExistsException:
The resource already exists.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
UpdateAssetModel
$result = $client->updateAssetModel
([/* ... */]); $promise = $client->updateAssetModelAsync
([/* ... */]);
Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in 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 samename
as the previous one and IoT SiteWise will generate a new uniqueid
.
Parameter Syntax
$result = $client->updateAssetModel([ 'assetModelCompositeModels' => [ [ 'description' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', // REQUIRED 'properties' => [ [ 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', // REQUIRED 'dataTypeSpec' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', // REQUIRED 'path' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'type' => [ // REQUIRED 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ 'processingConfig' => [ 'forwardingConfig' => [ // REQUIRED 'state' => 'DISABLED|ENABLED', // REQUIRED ], ], ], 'metric' => [ 'expression' => '<string>', // REQUIRED 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', // REQUIRED ], 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], 'window' => [ // REQUIRED 'tumbling' => [ 'interval' => '<string>', // REQUIRED 'offset' => '<string>', ], ], ], 'transform' => [ 'expression' => '<string>', // REQUIRED 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', // REQUIRED 'forwardingConfig' => [ 'state' => 'DISABLED|ENABLED', // REQUIRED ], ], 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], ], ], 'unit' => '<string>', ], // ... ], 'type' => '<string>', // REQUIRED ], // ... ], 'assetModelDescription' => '<string>', 'assetModelExternalId' => '<string>', 'assetModelHierarchies' => [ [ 'childAssetModelId' => '<string>', // REQUIRED 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', // REQUIRED ], // ... ], 'assetModelId' => '<string>', // REQUIRED 'assetModelName' => '<string>', // REQUIRED 'assetModelProperties' => [ [ 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', // REQUIRED 'dataTypeSpec' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', // REQUIRED 'path' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'type' => [ // REQUIRED 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ 'processingConfig' => [ 'forwardingConfig' => [ // REQUIRED 'state' => 'DISABLED|ENABLED', // REQUIRED ], ], ], 'metric' => [ 'expression' => '<string>', // REQUIRED 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', // REQUIRED ], 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], 'window' => [ // REQUIRED 'tumbling' => [ 'interval' => '<string>', // REQUIRED 'offset' => '<string>', ], ], ], 'transform' => [ 'expression' => '<string>', // REQUIRED 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', // REQUIRED 'forwardingConfig' => [ 'state' => 'DISABLED|ENABLED', // REQUIRED ], ], 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], ], ], 'unit' => '<string>', ], // ... ], 'clientToken' => '<string>', 'ifMatch' => '<string>', 'ifNoneMatch' => '<string>', 'matchForVersionType' => 'LATEST|ACTIVE', ]);
Parameter Details
Members
- assetModelCompositeModels
-
- Type: Array of AssetModelCompositeModel structures
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.
- assetModelDescription
-
- Type: string
A description for the asset model.
- assetModelExternalId
-
- Type: 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.
- assetModelHierarchies
-
- Type: Array of AssetModelHierarchy structures
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.
- assetModelId
-
- Required: Yes
- Type: string
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. - assetModelName
-
- Required: Yes
- Type: string
A unique name for the asset model.
- assetModelProperties
-
- Type: Array of AssetModelProperty structures
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.
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- ifMatch
-
- Type: 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. - ifNoneMatch
-
- Type: string
Accepts * to reject the update request if an active version (specified using
matchForVersionType
asACTIVE
) already exists for the asset model. - matchForVersionType
-
- Type: string
Specifies the asset model version type (
LATEST
orACTIVE
) used in conjunction withIf-Match
orIf-None-Match
headers to determine the target ETag for the update operation.
Result Syntax
[ 'assetModelStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|PROPAGATING|DELETING|FAILED', ], ]
Result Details
Members
- assetModelStatus
-
- Required: Yes
- Type: AssetModelStatus structure
The status of the asset model, which contains a state (
UPDATING
after successfully calling this operation) and any error message.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceAlreadyExistsException:
The resource already exists.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
- PreconditionFailedException:
The precondition in one or more of the request-header fields evaluated to
FALSE
.
UpdateAssetModelCompositeModel
$result = $client->updateAssetModelCompositeModel
([/* ... */]); $promise = $client->updateAssetModelCompositeModelAsync
([/* ... */]);
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 models in 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 samename
as the previous one and IoT SiteWise will generate a new uniqueid
.
Parameter Syntax
$result = $client->updateAssetModelCompositeModel([ 'assetModelCompositeModelDescription' => '<string>', 'assetModelCompositeModelExternalId' => '<string>', 'assetModelCompositeModelId' => '<string>', // REQUIRED 'assetModelCompositeModelName' => '<string>', // REQUIRED 'assetModelCompositeModelProperties' => [ [ 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', // REQUIRED 'dataTypeSpec' => '<string>', 'externalId' => '<string>', 'id' => '<string>', 'name' => '<string>', // REQUIRED 'path' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'type' => [ // REQUIRED 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ 'processingConfig' => [ 'forwardingConfig' => [ // REQUIRED 'state' => 'DISABLED|ENABLED', // REQUIRED ], ], ], 'metric' => [ 'expression' => '<string>', // REQUIRED 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', // REQUIRED ], 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], 'window' => [ // REQUIRED 'tumbling' => [ 'interval' => '<string>', // REQUIRED 'offset' => '<string>', ], ], ], 'transform' => [ 'expression' => '<string>', // REQUIRED 'processingConfig' => [ 'computeLocation' => 'EDGE|CLOUD', // REQUIRED 'forwardingConfig' => [ 'state' => 'DISABLED|ENABLED', // REQUIRED ], ], 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', 'propertyPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], ], ], // ... ], ], ], 'unit' => '<string>', ], // ... ], 'assetModelId' => '<string>', // REQUIRED 'clientToken' => '<string>', 'ifMatch' => '<string>', 'ifNoneMatch' => '<string>', 'matchForVersionType' => 'LATEST|ACTIVE', ]);
Parameter Details
Members
- assetModelCompositeModelDescription
-
- Type: string
A description for the composite model.
- assetModelCompositeModelExternalId
-
- Type: 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.
- assetModelCompositeModelId
-
- Required: Yes
- Type: string
The ID of a composite model on this asset model.
- assetModelCompositeModelName
-
- Required: Yes
- Type: string
A unique name for the composite model.
- assetModelCompositeModelProperties
-
- Type: Array of AssetModelProperty structures
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.
- assetModelId
-
- Required: Yes
- Type: string
The ID of the asset model, in UUID format.
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- ifMatch
-
- Type: 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. - ifNoneMatch
-
- Type: string
Accepts * to reject the update request if an active version (specified using
matchForVersionType
asACTIVE
) already exists for the asset model. - matchForVersionType
-
- Type: string
Specifies the asset model version type (
LATEST
orACTIVE
) used in conjunction withIf-Match
orIf-None-Match
headers to determine the target ETag for the update operation.
Result Syntax
[ 'assetModelCompositeModelPath' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'assetModelStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|PROPAGATING|DELETING|FAILED', ], ]
Result Details
Members
- assetModelCompositeModelPath
-
- Required: Yes
- Type: Array of AssetModelCompositeModelPathSegment structures
The path to the composite model listing the parent composite models.
- assetModelStatus
-
- Required: Yes
- Type: AssetModelStatus structure
Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide.
Errors
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
- PreconditionFailedException:
The precondition in one or more of the request-header fields evaluated to
FALSE
.- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceAlreadyExistsException:
The resource already exists.
- ResourceNotFoundException:
The requested resource can't be found.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
UpdateAssetProperty
$result = $client->updateAssetProperty
([/* ... */]); $promise = $client->updateAssetPropertyAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->updateAssetProperty([ 'assetId' => '<string>', // REQUIRED 'clientToken' => '<string>', 'propertyAlias' => '<string>', 'propertyId' => '<string>', // REQUIRED 'propertyNotificationState' => 'ENABLED|DISABLED', 'propertyUnit' => '<string>', ]);
Parameter Details
Members
- assetId
-
- Required: Yes
- Type: string
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. - clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- propertyAlias
-
- Type: string
The alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.If you omit this parameter, the alias is removed from the property.
- propertyId
-
- Required: Yes
- Type: 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. - propertyNotificationState
-
- Type: 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
. - propertyUnit
-
- Type: string
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.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
UpdateDashboard
$result = $client->updateDashboard
([/* ... */]); $promise = $client->updateDashboardAsync
([/* ... */]);
Updates an IoT SiteWise Monitor dashboard.
Parameter Syntax
$result = $client->updateDashboard([ 'clientToken' => '<string>', 'dashboardDefinition' => '<string>', // REQUIRED 'dashboardDescription' => '<string>', 'dashboardId' => '<string>', // REQUIRED 'dashboardName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- dashboardDefinition
-
- Required: Yes
- Type: string
The new dashboard definition, as specified in a JSON literal.
-
IoT SiteWise Monitor (Classic) see Create dashboards (CLI)
-
IoT SiteWise Monitor (AI-aware) see Create dashboards (CLI)
in the IoT SiteWise User Guide
- dashboardDescription
-
- Type: string
A new description for the dashboard.
- dashboardId
-
- Required: Yes
- Type: string
The ID of the dashboard to update.
- dashboardName
-
- Required: Yes
- Type: string
A new friendly name for the dashboard.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
UpdateDataset
$result = $client->updateDataset
([/* ... */]); $promise = $client->updateDatasetAsync
([/* ... */]);
Updates a dataset.
Parameter Syntax
$result = $client->updateDataset([ 'clientToken' => '<string>', 'datasetDescription' => '<string>', 'datasetId' => '<string>', // REQUIRED 'datasetName' => '<string>', // REQUIRED 'datasetSource' => [ // REQUIRED 'sourceDetail' => [ 'kendra' => [ 'knowledgeBaseArn' => '<string>', // REQUIRED 'roleArn' => '<string>', // REQUIRED ], ], 'sourceFormat' => 'KNOWLEDGE_BASE', // REQUIRED 'sourceType' => 'KENDRA', // REQUIRED ], ]);
Parameter Details
Members
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- datasetDescription
-
- Type: string
A description about the dataset, and its functionality.
- datasetId
-
- Required: Yes
- Type: string
The ID of the dataset.
- datasetName
-
- Required: Yes
- Type: string
The name of the dataset.
- datasetSource
-
- Required: Yes
- Type: DatasetSource structure
The data source for the dataset.
Result Syntax
[ 'datasetArn' => '<string>', 'datasetId' => '<string>', 'datasetStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'details' => [ [ 'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION', 'message' => '<string>', ], // ... ], 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED', ], ]
Result Details
Members
- datasetArn
-
- Type: string
The ARN of the dataset. The format is
arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}
. - datasetId
-
- Type: string
The ID of the dataset.
- datasetStatus
-
- Type: DatasetStatus structure
The status of the dataset. This contains the state and any error messages. State is
UPDATING
after a successfull call to this API, and any associated error message. The state isACTIVE
when ready to use.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
UpdateGateway
$result = $client->updateGateway
([/* ... */]); $promise = $client->updateGatewayAsync
([/* ... */]);
Updates a gateway's name.
Parameter Syntax
$result = $client->updateGateway([ 'gatewayId' => '<string>', // REQUIRED 'gatewayName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- gatewayId
-
- Required: Yes
- Type: string
The ID of the gateway to update.
- gatewayName
-
- Required: Yes
- Type: string
A unique name for the gateway.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
UpdateGatewayCapabilityConfiguration
$result = $client->updateGatewayCapabilityConfiguration
([/* ... */]); $promise = $client->updateGatewayCapabilityConfigurationAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->updateGatewayCapabilityConfiguration([ 'capabilityConfiguration' => '<string>', // REQUIRED 'capabilityNamespace' => '<string>', // REQUIRED 'gatewayId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- capabilityConfiguration
-
- Required: Yes
- Type: string
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.
- capabilityNamespace
-
- Required: Yes
- Type: 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
, whereversion
is a number such as1
. - gatewayId
-
- Required: Yes
- Type: string
The ID of the gateway to be updated.
Result Syntax
[ 'capabilityNamespace' => '<string>', 'capabilitySyncStatus' => 'IN_SYNC|OUT_OF_SYNC|SYNC_FAILED|UNKNOWN|NOT_APPLICABLE', ]
Result Details
Members
- capabilityNamespace
-
- Required: Yes
- Type: string
The namespace of the gateway capability.
- capabilitySyncStatus
-
- Required: Yes
- Type: 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. -
NOT_APPLICABLE
– Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner. -
OUT_OF_SYNC
– The gateway hasn't received the capability configuration. -
SYNC_FAILED
– The gateway rejected the capability configuration. -
UNKNOWN
– The synchronization status is currently unknown due to an undetermined or temporary error.
After you update a capability configuration, its sync status is
OUT_OF_SYNC
until the gateway receives and applies or rejects the updated configuration.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- LimitExceededException:
You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
UpdatePortal
$result = $client->updatePortal
([/* ... */]); $promise = $client->updatePortalAsync
([/* ... */]);
Updates an IoT SiteWise Monitor portal.
Parameter Syntax
$result = $client->updatePortal([ 'alarms' => [ 'alarmRoleArn' => '<string>', // REQUIRED 'notificationLambdaArn' => '<string>', ], 'clientToken' => '<string>', 'notificationSenderEmail' => '<string>', 'portalContactEmail' => '<string>', // REQUIRED 'portalDescription' => '<string>', 'portalId' => '<string>', // REQUIRED 'portalLogoImage' => [ 'file' => [ 'data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'type' => 'PNG', // REQUIRED ], 'id' => '<string>', ], 'portalName' => '<string>', // REQUIRED 'portalType' => 'SITEWISE_PORTAL_V1|SITEWISE_PORTAL_V2', 'portalTypeConfiguration' => [ '<PortalTypeKey>' => [ 'portalTools' => ['<string>', ...], ], // ... ], 'roleArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- alarms
-
- Type: Alarms structure
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.
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- notificationSenderEmail
-
- Type: string
The email address that sends alarm notifications.
- portalContactEmail
-
- Required: Yes
- Type: string
The Amazon Web Services administrator's contact email address.
- portalDescription
-
- Type: string
A new description for the portal.
- portalId
-
- Required: Yes
- Type: string
The ID of the portal to update.
- portalLogoImage
-
- Type: Image structure
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.
- portalName
-
- Required: Yes
- Type: string
A new friendly name for the portal.
- portalType
-
- Type: string
Define the type of portal. The value for IoT SiteWise Monitor (Classic) is
SITEWISE_PORTAL_V1
. The value for IoT SiteWise Monitor (AI-aware) isSITEWISE_PORTAL_V2
. - portalTypeConfiguration
-
- Type: Associative array of custom strings keys (PortalTypeKey) to PortalTypeEntry structures
The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is
SITEWISE_PORTAL_V1
. The value for IoT SiteWise Monitor (AI-aware) isSITEWISE_PORTAL_V2
. - roleArn
-
- Required: Yes
- Type: 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.
Result Syntax
[ 'portalStatus' => [ 'error' => [ 'code' => 'INTERNAL_FAILURE|VALIDATION_ERROR|LIMIT_EXCEEDED', 'message' => '<string>', ], 'state' => 'CREATING|PENDING|UPDATING|DELETING|ACTIVE|FAILED', ], ]
Result Details
Members
- portalStatus
-
- Required: Yes
- Type: PortalStatus structure
The status of the portal, which contains a state (
UPDATING
after successfully calling this operation) and any error message.
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
- ConflictingOperationException:
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
UpdateProject
$result = $client->updateProject
([/* ... */]); $promise = $client->updateProjectAsync
([/* ... */]);
Updates an IoT SiteWise Monitor project.
Parameter Syntax
$result = $client->updateProject([ 'clientToken' => '<string>', 'projectDescription' => '<string>', 'projectId' => '<string>', // REQUIRED 'projectName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clientToken
-
- Type: string
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
- projectDescription
-
- Type: string
A new description for the project.
- projectId
-
- Required: Yes
- Type: string
The ID of the project to update.
- projectName
-
- Required: Yes
- Type: string
A new friendly name for the project.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
- ResourceNotFoundException:
The requested resource can't be found.
- InternalFailureException:
IoT SiteWise can't process your request right now. Try again later.
- ThrottlingException:
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
Shapes
AccessDeniedException
Description
Access is denied.
Members
- message
-
- Type: string
AccessPolicySummary
Description
Contains an access policy that defines an identity's access to an IoT SiteWise Monitor resource.
Members
- creationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the access policy was created, in Unix epoch time.
- id
-
- Required: Yes
- Type: string
The ID of the access policy.
- identity
-
- Required: Yes
- Type: Identity structure
The identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user).
- lastUpdateDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the access policy was last updated, in Unix epoch time.
- permission
-
- Required: Yes
- Type: string
The permissions for the access policy. Note that a project
ADMINISTRATOR
is also known as a project owner. - resource
-
- Required: Yes
- Type: Resource structure
The IoT SiteWise Monitor resource (a portal or project).
ActionDefinition
Description
Contains a definition for an action.
Members
- actionDefinitionId
-
- Required: Yes
- Type: string
The ID of the action definition.
- actionName
-
- Required: Yes
- Type: string
The name of the action definition.
- actionType
-
- Required: Yes
- Type: string
The type of the action definition.
ActionPayload
Description
The JSON payload of the action.
Members
- stringValue
-
- Required: Yes
- Type: string
The payload of the action in a JSON string.
ActionSummary
Description
Contains the summary of the actions.
Members
- actionDefinitionId
-
- Type: string
The ID of the action definition.
- actionId
-
- Type: string
The ID of the action.
- targetResource
-
- Type: TargetResource structure
The resource the action will be taken on.
AggregatedValue
Description
Contains aggregated asset property values (for example, average, minimum, and maximum).
Members
- quality
-
- Type: string
The quality of the aggregated data.
- timestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the aggregating computations occurred, in Unix epoch time.
- value
-
- Required: Yes
- Type: Aggregates structure
The value of the aggregates.
Aggregates
Description
Contains the (pre-calculated) aggregate values for an asset property.
Members
- average
-
- Type: double
The average (mean) value of the time series over a time interval window.
- count
-
- Type: double
The count of data points in the time series over a time interval window.
- maximum
-
- Type: double
The maximum value of the time series over a time interval window.
- minimum
-
- Type: double
The minimum value of the time series over a time interval window.
- standardDeviation
-
- Type: double
The standard deviation of the time series over a time interval window.
- sum
-
- Type: double
The sum of the time series over a time interval window.
Alarms
Description
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.
Members
- alarmRoleArn
-
- Required: Yes
- Type: string
The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.
- notificationLambdaArn
-
- Type: string
The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the IoT Events Developer Guide.
AssetCompositeModel
Description
Contains information about a composite model in an asset. This object contains the asset's properties that you define in the composite model.
Members
- description
-
- Type: string
The description of the composite model.
- externalId
-
- Type: string
The external ID of the asset composite model. For more information, see Using external IDs in the IoT SiteWise User Guide.
- id
-
- Type: string
The ID of the asset composite model.
- name
-
- Required: Yes
- Type: string
The name of the composite model.
- properties
-
- Required: Yes
- Type: Array of AssetProperty structures
The asset properties that this composite model defines.
- type
-
- Required: Yes
- Type: string
The type of the composite model. For alarm composite models, this type is
AWS/ALARM
.
AssetCompositeModelPathSegment
Description
Represents one level between a composite model and the root of the asset.
Members
- id
-
- Type: string
The ID of the path segment.
- name
-
- Type: string
The name of the path segment.
AssetCompositeModelSummary
Description
Contains a summary of the composite model for a specific asset.
Members
- description
-
- Required: Yes
- Type: string
A description of the composite model that this summary describes.
- externalId
-
- Type: string
An external ID to assign to the asset 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. - id
-
- Required: Yes
- Type: string
The ID of the composite model that this summary describes.
- name
-
- Required: Yes
- Type: string
The name of the composite model that this summary describes.
- path
-
- Required: Yes
- Type: Array of AssetCompositeModelPathSegment structures
The path that includes all the components of the asset model for the asset.
- type
-
- Required: Yes
- Type: 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.
AssetErrorDetails
Description
Contains error details for the requested associate project asset action.
Members
- assetId
-
- Required: Yes
- Type: string
The ID of the asset, in UUID format.
- code
-
- Required: Yes
- Type: string
The error code.
- message
-
- Required: Yes
- Type: string
The error message.
AssetHierarchy
Description
Describes an asset hierarchy that contains a hierarchy's name and ID.
Members
- externalId
-
- Type: string
The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you may assign an external ID if it doesn't already have one. You can't change the external ID of an asset hierarchy that already has one. For more information, see Using external IDs in the IoT SiteWise User Guide.
- id
-
- Type: string
The ID of the hierarchy. This ID is a
hierarchyId
. - name
-
- Required: Yes
- Type: string
The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.
AssetHierarchyInfo
Description
Contains information about a parent asset and a child asset that are related through an asset hierarchy.
Members
- childAssetId
-
- Type: string
The ID of the child asset in this asset relationship.
- parentAssetId
-
- Type: string
The ID of the parent asset in this asset relationship.
AssetModelCompositeModel
Description
Contains information about a composite model in an asset model. This object contains the asset property definitions that you define in the composite model.
Members
- description
-
- Type: string
The description of the composite model.
- externalId
-
- Type: string
The external ID of the asset model composite model. For more information, see Using external IDs in the IoT SiteWise User Guide.
- id
-
- Type: string
The ID of the asset model composite model.
- name
-
- Required: Yes
- Type: string
The name of the composite model.
- properties
-
- Type: Array of AssetModelProperty structures
The asset property definitions for this composite model.
- type
-
- Required: Yes
- Type: string
The type of the composite model. For alarm composite models, this type is
AWS/ALARM
.
AssetModelCompositeModelDefinition
Description
Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.
Members
- description
-
- Type: string
The description of the composite model.
- externalId
-
- Type: string
An external ID to assign to the composite model. The external ID must be unique among composite models within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
- id
-
- Type: string
The ID to assign to the composite 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.
- name
-
- Required: Yes
- Type: string
The name of the composite model.
- properties
-
- Type: Array of AssetModelPropertyDefinition structures
The asset property definitions for this composite model.
- type
-
- Required: Yes
- Type: string
The type of the composite model. For alarm composite models, this type is
AWS/ALARM
.
AssetModelCompositeModelPathSegment
Description
Represents one level between a composite model and the root of the asset model.
Members
- id
-
- Type: string
The ID of the path segment.
- name
-
- Type: string
The name of the path segment.
AssetModelCompositeModelSummary
Description
Contains a summary of the composite model.
Members
- description
-
- Type: string
The description of the composite model that this summary describes..
- externalId
-
- Type: string
The external ID of a composite model on this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
- id
-
- Required: Yes
- Type: string
The ID of the composite model that this summary describes..
- name
-
- Required: Yes
- Type: string
The name of the composite model that this summary describes..
- path
-
- Type: Array of AssetModelCompositeModelPathSegment structures
The path that includes all the pieces that make up the composite model.
- type
-
- Required: Yes
- Type: string
The composite model type. Valid values are
AWS/ALARM
,CUSTOM
, orAWS/L4E_ANOMALY
.
AssetModelHierarchy
Description
Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.
Members
- childAssetModelId
-
- Required: Yes
- Type: string
The ID of the asset model, in UUID format. All assets in this hierarchy must be instances of the
childAssetModelId
asset model. IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to UpdateAssetModel, you may provide either the asset model ID or elseexternalId:
followed by the asset model's external ID. For more information, see Using external IDs in the IoT SiteWise User Guide. - externalId
-
- Type: string
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
- id
-
- Type: string
The ID of the asset model hierarchy. This ID is a
hierarchyId
.-
If you are callling UpdateAssetModel to create a new hierarchy: You can specify its ID here, 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.
-
If you are calling UpdateAssetModel to modify an existing hierarchy: 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.
- name
-
- Required: Yes
- Type: string
The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
AssetModelHierarchyDefinition
Description
Contains an asset model hierarchy used in asset model creation. An asset model hierarchy determines the kind (or type) of asset that can belong to a hierarchy.
Members
- childAssetModelId
-
- Required: Yes
- Type: string
The ID of an asset model for this hierarchy. 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. - externalId
-
- Type: string
An external ID to assign to the asset model hierarchy. The external ID must be unique among asset model hierarchies within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
- id
-
- Type: string
The ID to assign to the asset model hierarchy, 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.
- name
-
- Required: Yes
- Type: string
The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).
AssetModelProperty
Description
Contains information about an asset model property.
Members
- dataType
-
- Required: Yes
- Type: string
The data type of the asset model property.
If you specify
STRUCT
, you must also specifydataTypeSpec
to identify the type of the structure for this property. - dataTypeSpec
-
- Type: string
The data type of the structure for this property. This parameter exists on properties that have the
STRUCT
data type. - externalId
-
- Type: string
The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.
- id
-
- Type: string
The ID of the asset model property.
-
If you are callling UpdateAssetModel to create a new property: You can specify its ID here, 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.
-
If you are calling UpdateAssetModel to modify an existing 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.
- name
-
- Required: Yes
- Type: string
The name of the asset model property.
- path
-
- Type: Array of AssetModelPropertyPathSegment structures
The structured path to the property from the root of the asset model.
- type
-
- Required: Yes
- Type: PropertyType structure
The property type (see
PropertyType
). - unit
-
- Type: string
The unit of the asset model property, such as
Newtons
orRPM
.
AssetModelPropertyDefinition
Description
Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
Members
- dataType
-
- Required: Yes
- Type: string
The data type of the property definition.
If you specify
STRUCT
, you must also specifydataTypeSpec
to identify the type of the structure for this property. - dataTypeSpec
-
- Type: string
The data type of the structure for this property. This parameter is required on properties that have the
STRUCT
data type.The options for this parameter depend on the type of the composite model in which you define this property. Use
AWS/ALARM_STATE
for alarm state in alarm composite models. - externalId
-
- Type: string
An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
- id
-
- Type: string
The ID to assign to the asset model property, 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.
- name
-
- Required: Yes
- Type: string
The name of the property definition.
- type
-
- Required: Yes
- Type: PropertyType structure
The property definition type (see
PropertyType
). You can only specify one type in a property definition. - unit
-
- Type: string
The unit of the property definition, such as
Newtons
orRPM
.
AssetModelPropertyPathSegment
Description
Represents one level between a property and the root of the asset model.
Members
- id
-
- Type: string
The ID of the path segment.
- name
-
- Type: string
The name of the path segment.
AssetModelPropertySummary
Description
Contains a summary of a property associated with a model.
Members
- assetModelCompositeModelId
-
- Type: string
The ID of the composite model that contains the asset model property.
- dataType
-
- Required: Yes
- Type: string
The data type of the property.
- dataTypeSpec
-
- Type: string
The data type of the structure for this property. This parameter exists on properties that have the
STRUCT
data type. - externalId
-
- Type: string
The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
- id
-
- Type: string
The ID of the property.
- name
-
- Required: Yes
- Type: string
The name of the property.
- path
-
- Type: Array of AssetModelPropertyPathSegment structures
The structured path to the property from the root of the asset model.
- type
-
- Required: Yes
- Type: PropertyType structure
Contains a property type, which can be one of
attribute
,measurement
,metric
, ortransform
. - unit
-
- Type: string
The unit (such as
Newtons
orRPM
) of the property.
AssetModelStatus
Description
Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide.
Members
- error
-
- Type: ErrorDetails structure
Contains associated error information, if any.
- state
-
- Required: Yes
- Type: string
The current state of the asset model.
AssetModelSummary
Description
Contains a summary of an asset model.
Members
- arn
-
- Required: Yes
- Type: string
The ARN of the asset model, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
- assetModelType
-
- Type: 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.
- creationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the asset model was created, in Unix epoch time.
- description
-
- Required: Yes
- Type: string
The asset model description.
- externalId
-
- Type: string
The external ID of the asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
- id
-
- Required: Yes
- Type: string
The ID of the asset model (used with IoT SiteWise API operations).
- lastUpdateDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the asset model was last updated, in Unix epoch time.
- name
-
- Required: Yes
- Type: string
The name of the asset model.
- status
-
- Required: Yes
- Type: AssetModelStatus structure
The current status of the asset model.
- version
-
- Type: string
The version number of the asset model.
AssetProperty
Description
Contains asset property information.
Members
- alias
-
- Type: string
The alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. - dataType
-
- Required: Yes
- Type: string
The data type of the asset property.
- dataTypeSpec
-
- Type: string
The data type of the structure for this property. This parameter exists on properties that have the
STRUCT
data type. - externalId
-
- Type: string
The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide.
- id
-
- Required: Yes
- Type: string
The ID of the asset property.
- name
-
- Required: Yes
- Type: string
The name of the property.
- notification
-
- Type: PropertyNotification structure
The asset property's notification topic and state. For more information, see UpdateAssetProperty.
- path
-
- Type: Array of AssetPropertyPathSegment structures
The structured path to the property from the root of the asset.
- unit
-
- Type: string
The unit (such as
Newtons
orRPM
) of the asset property.
AssetPropertyPathSegment
Description
Represents one level between a property and the root of the asset.
Members
- id
-
- Type: string
The ID of the path segment.
- name
-
- Type: string
The name of the path segment.
AssetPropertySummary
Description
Contains a summary of a property associated with an asset.
Members
- alias
-
- Type: string
The alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. - assetCompositeModelId
-
- Type: string
The ID of the composite model that contains the asset property.
- externalId
-
- Type: string
The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
- id
-
- Required: Yes
- Type: string
The ID of the property.
- notification
-
- Type: PropertyNotification structure
Contains asset property value notification information. 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.
- path
-
- Type: Array of AssetPropertyPathSegment structures
The structured path to the property from the root of the asset.
- unit
-
- Type: string
The unit of measure (such as Newtons or RPM) of the asset property.
AssetPropertyValue
Description
Contains asset property value information.
Members
- quality
-
- Type: string
The quality of the asset property value.
- timestamp
-
- Required: Yes
- Type: TimeInNanos structure
The timestamp of the asset property value.
- value
-
- Required: Yes
- Type: Variant structure
The value of the asset property (see
Variant
).
AssetRelationshipSummary
Description
Contains information about assets that are related to one another.
Members
- hierarchyInfo
-
- Type: AssetHierarchyInfo structure
The assets that are related through an asset hierarchy.
This object is present if the
relationshipType
isHIERARCHY
. - relationshipType
-
- Required: Yes
- Type: string
The relationship type of the assets in this relationship. This value is one of the following:
-
HIERARCHY
– The assets are related through an asset hierarchy. If you specify this relationship type, this asset relationship includes thehierarchyInfo
object.
AssetStatus
Description
Contains information about the current status of an asset. For more information, see Asset and model states in the IoT SiteWise User Guide.
Members
- error
-
- Type: ErrorDetails structure
Contains associated error information, if any.
- state
-
- Required: Yes
- Type: string
The current status of the asset.
AssetSummary
Description
Contains a summary of an asset.
Members
- arn
-
- Required: Yes
- Type: string
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
- assetModelId
-
- Required: Yes
- Type: string
The ID of the asset model used to create this asset.
- creationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the asset was created, in Unix epoch time.
- description
-
- Type: string
A description for the asset.
- externalId
-
- Type: string
The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.
- hierarchies
-
- Required: Yes
- Type: Array of AssetHierarchy structures
A list of asset hierarchies that each contain a
hierarchyId
. A hierarchy specifies allowed parent/child asset relationships. - id
-
- Required: Yes
- Type: string
The ID of the asset, in UUID format.
- lastUpdateDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the asset was last updated, in Unix epoch time.
- name
-
- Required: Yes
- Type: string
The name of the asset.
- status
-
- Required: Yes
- Type: AssetStatus structure
The current status of the asset.
AssociatedAssetsSummary
Description
Contains a summary of an associated asset.
Members
- arn
-
- Required: Yes
- Type: string
The ARN of the asset, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
- assetModelId
-
- Required: Yes
- Type: string
The ID of the asset model used to create the asset.
- creationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the asset was created, in Unix epoch time.
- description
-
- Type: string
A description for the asset.
- externalId
-
- Type: string
The external ID of the asset. For more information, see Using external IDs in the IoT SiteWise User Guide.
- hierarchies
-
- Required: Yes
- Type: Array of AssetHierarchy structures
A list of asset hierarchies that each contain a
hierarchyId
. A hierarchy specifies allowed parent/child asset relationships. - id
-
- Required: Yes
- Type: string
The ID of the asset, in UUID format.
- lastUpdateDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the asset was last updated, in Unix epoch time.
- name
-
- Required: Yes
- Type: string
The name of the asset.
- status
-
- Required: Yes
- Type: AssetStatus structure
The current status of the asset.
Attribute
Description
Contains an asset attribute property. For more information, see Attributes in the IoT SiteWise User Guide.
Members
- defaultValue
-
- Type: string
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide.
BatchGetAssetPropertyAggregatesEntry
Description
Contains information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
To identify an asset property, you must specify one of the following:
-
The
assetId
andpropertyId
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.
Members
- aggregateTypes
-
- Required: Yes
- Type: Array of strings
The data aggregating function.
- assetId
-
- Type: string
The ID of the asset in which the asset property was created.
- endDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
- entryId
-
- Required: Yes
- Type: string
The ID of the entry.
- propertyAlias
-
- Type: string
The alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. - propertyId
-
- Type: string
The ID of the asset property, in UUID format.
- qualities
-
- Type: Array of strings
The quality by which to filter asset data.
- resolution
-
- Required: Yes
- Type: string
The time interval over which to aggregate data.
- startDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
- timeOrdering
-
- Type: string
The chronological sorting order of the requested information.
Default:
ASCENDING
BatchGetAssetPropertyAggregatesErrorEntry
Description
Contains error information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
Members
- entryId
-
- Required: Yes
- Type: string
The ID of the entry.
- errorCode
-
- Required: Yes
- Type: string
The error code.
- errorMessage
-
- Required: Yes
- Type: string
The associated error message.
BatchGetAssetPropertyAggregatesErrorInfo
Description
Contains the error code and the timestamp for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
Members
- errorCode
-
- Required: Yes
- Type: string
The error code.
- errorTimestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the error occurred, in Unix epoch time.
BatchGetAssetPropertyAggregatesSkippedEntry
Description
Contains information for an entry that has been processed by the previous BatchGetAssetPropertyAggregates request.
Members
- completionStatus
-
- Required: Yes
- Type: string
The completion status of each entry that is associated with the BatchGetAssetPropertyAggregates API.
- entryId
-
- Required: Yes
- Type: string
The ID of the entry.
- errorInfo
-
- Type: BatchGetAssetPropertyAggregatesErrorInfo structure
The error information, such as the error code and the timestamp.
BatchGetAssetPropertyAggregatesSuccessEntry
Description
Contains success information for an entry that is associated with the BatchGetAssetPropertyAggregates API.
Members
- aggregatedValues
-
- Required: Yes
- Type: Array of AggregatedValue structures
The requested aggregated asset property values (for example, average, minimum, and maximum).
- entryId
-
- Required: Yes
- Type: string
The ID of the entry.
BatchGetAssetPropertyValueEntry
Description
Contains information for an asset property value entry that is associated with the BatchGetAssetPropertyValue API.
To identify an asset property, you must specify one of the following:
-
The
assetId
andpropertyId
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.
Members
- assetId
-
- Type: string
The ID of the asset in which the asset property was created.
- entryId
-
- Required: Yes
- Type: string
The ID of the entry.
- propertyAlias
-
- Type: string
The alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. - propertyId
-
- Type: string
The ID of the asset property, in UUID format.
BatchGetAssetPropertyValueErrorEntry
Description
Contains error information for an asset property value entry that is associated with the BatchGetAssetPropertyValue API.
Members
- entryId
-
- Required: Yes
- Type: string
The ID of the entry.
- errorCode
-
- Required: Yes
- Type: string
The error code.
- errorMessage
-
- Required: Yes
- Type: string
The associated error message.
BatchGetAssetPropertyValueErrorInfo
Description
The error information, such as the error code and the timestamp.
Members
- errorCode
-
- Required: Yes
- Type: string
The error code.
- errorTimestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the error occurred, in Unix epoch time.
BatchGetAssetPropertyValueHistoryEntry
Description
Contains information for an asset property historical value entry that is associated with the BatchGetAssetPropertyValueHistory API.
To identify an asset property, you must specify one of the following:
-
The
assetId
andpropertyId
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.
Members
- assetId
-
- Type: string
The ID of the asset in which the asset property was created.
- endDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
- entryId
-
- Required: Yes
- Type: string
The ID of the entry.
- propertyAlias
-
- Type: string
The alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. - propertyId
-
- Type: string
The ID of the asset property, in UUID format.
- qualities
-
- Type: Array of strings
The quality by which to filter asset data.
- startDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
- timeOrdering
-
- Type: string
The chronological sorting order of the requested information.
Default:
ASCENDING
BatchGetAssetPropertyValueHistoryErrorEntry
Description
A list of the errors (if any) associated with the batch request. Each error entry contains the entryId
of the entry that failed.
Members
- entryId
-
- Required: Yes
- Type: string
The ID of the entry.
- errorCode
-
- Required: Yes
- Type: string
The error code.
- errorMessage
-
- Required: Yes
- Type: string
The associated error message.
BatchGetAssetPropertyValueHistoryErrorInfo
Description
The error information, such as the error code and the timestamp.
Members
- errorCode
-
- Required: Yes
- Type: string
The error code.
- errorTimestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the error occurred, in Unix epoch time.
BatchGetAssetPropertyValueHistorySkippedEntry
Description
Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValueHistory request.
Members
- completionStatus
-
- Required: Yes
- Type: string
The completion status of each entry that is associated with the BatchGetAssetPropertyValueHistory API.
- entryId
-
- Required: Yes
- Type: string
The ID of the entry.
- errorInfo
-
- Type: BatchGetAssetPropertyValueHistoryErrorInfo structure
The error information, such as the error code and the timestamp.
BatchGetAssetPropertyValueHistorySuccessEntry
Description
Contains success information for an entry that is associated with the BatchGetAssetPropertyValueHistory API.
Members
- assetPropertyValueHistory
-
- Required: Yes
- Type: Array of AssetPropertyValue structures
The requested historical values for the specified asset property.
- entryId
-
- Required: Yes
- Type: string
The ID of the entry.
BatchGetAssetPropertyValueSkippedEntry
Description
Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValue request.
Members
- completionStatus
-
- Required: Yes
- Type: string
The completion status of each entry that is associated with the BatchGetAssetPropertyValue request.
- entryId
-
- Required: Yes
- Type: string
The ID of the entry.
- errorInfo
-
- Type: BatchGetAssetPropertyValueErrorInfo structure
The error information, such as the error code and the timestamp.
BatchGetAssetPropertyValueSuccessEntry
Description
Contains success information for an entry that is associated with the BatchGetAssetPropertyValue API.
Members
- assetPropertyValue
-
- Type: AssetPropertyValue structure
Contains asset property value information.
- entryId
-
- Required: Yes
- Type: string
The ID of the entry.
BatchPutAssetPropertyError
Description
Contains error information from updating a batch of asset property values.
Members
- errorCode
-
- Required: Yes
- Type: string
The error code.
- errorMessage
-
- Required: Yes
- Type: string
The associated error message.
- timestamps
-
- Required: Yes
- Type: Array of TimeInNanos structures
A list of timestamps for each error, if any.
BatchPutAssetPropertyErrorEntry
Description
Contains error information for asset property value entries that are associated with the BatchPutAssetPropertyValue API.
Members
- entryId
-
- Required: Yes
- Type: string
The ID of the failed entry.
- errors
-
- Required: Yes
- Type: Array of BatchPutAssetPropertyError structures
The list of update property value errors.
Citation
Description
Contains text content to which the SiteWise Assistant refers to, and generate the final response. It also contains information about the source.
Members
ColumnInfo
Description
A description of the column in the query results.
Members
- name
-
- Type: string
The name of the column description.
- type
-
- Type: ColumnType structure
The type of the column description.
ColumnType
Description
The data type of the column.
Members
- scalarType
-
- Type: string
The allowed data types that the column has as it's value.
CompositeModelProperty
Description
Contains information about a composite model property on an asset.
Members
- assetProperty
-
- Required: Yes
- Type: Property structure
Contains asset property information.
- externalId
-
- Type: string
The external ID of the composite model that contains the property. For more information, see Using external IDs in the IoT SiteWise User Guide.
- id
-
- Type: string
The ID of the composite model that contains the property.
- name
-
- Required: Yes
- Type: string
The name of the property.
- type
-
- Required: Yes
- Type: string
The type of the composite model that defines this property.
CompositionDetails
Description
Metadata for the composition relationship established by using composedAssetModelId
in CreateAssetModelCompositeModel
.
Members
- compositionRelationship
-
- Type: Array of CompositionRelationshipItem structures
An array detailing the composition relationship for this composite model.
CompositionRelationshipItem
Description
Represents a composite model that composed an asset model of type COMPONENT_MODEL
.
Members
- id
-
- Type: string
The ID of the component.
CompositionRelationshipSummary
Description
Contains a summary of the components of the composite model.
Members
- assetModelCompositeModelId
-
- Required: Yes
- Type: string
The ID of a composite model on this asset model.
- assetModelCompositeModelType
-
- Required: Yes
- Type: string
The composite model type. Valid values are
AWS/ALARM
,CUSTOM
, orAWS/L4E_ANOMALY
. - assetModelId
-
- Required: Yes
- Type: string
The ID of the asset model, in UUID format.
ConfigurationErrorDetails
Description
Contains the details of an IoT SiteWise configuration error.
Members
- code
-
- Required: Yes
- Type: string
The error code.
- message
-
- Required: Yes
- Type: string
The error message.
ConfigurationStatus
Description
Contains current status information for the configuration.
Members
- error
-
- Type: ConfigurationErrorDetails structure
Contains associated error information, if any.
- state
-
- Required: Yes
- Type: string
The current state of the configuration.
ConflictingOperationException
Description
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
Members
- message
-
- Required: Yes
- Type: string
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource that conflicts with this operation.
- resourceId
-
- Required: Yes
- Type: string
The ID of the resource that conflicts with this operation.
Content
Description
Contains the cited text from the data source.
Members
- text
-
- Type: string
The cited text from the data source.
Csv
Description
A .CSV file.
Members
- columnNames
-
- Required: Yes
- Type: Array of strings
The column names specified in the .csv file.
CustomerManagedS3Storage
Description
Contains information about a customer managed Amazon S3 bucket.
Members
- roleArn
-
- Required: Yes
- Type: string
The ARN of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon S3.
- s3ResourceArn
-
- Required: Yes
- Type: string
The ARN of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see Amazon S3 resources in the Amazon Simple Storage Service User Guide.
DashboardSummary
Description
Contains a dashboard summary.
Members
- creationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the dashboard was created, in Unix epoch time.
- description
-
- Type: string
The dashboard's description.
- id
-
- Required: Yes
- Type: string
The ID of the dashboard.
- lastUpdateDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the dashboard was last updated, in Unix epoch time.
- name
-
- Required: Yes
- Type: string
The name of the dashboard
DataSetReference
DatasetSource
Description
The data source for the dataset.
Members
- sourceDetail
-
- Type: SourceDetail structure
The details of the dataset source associated with the dataset.
- sourceFormat
-
- Required: Yes
- Type: string
The format of the dataset source associated with the dataset.
- sourceType
-
- Required: Yes
- Type: string
The type of data source for the dataset.
DatasetStatus
Description
The status of the dataset. This contains the state and any error messages. The state is ACTIVE
when ready to use.
Members
- error
-
- Type: ErrorDetails structure
Contains the details of an IoT SiteWise error.
- state
-
- Required: Yes
- Type: string
The current status of the dataset.
DatasetSummary
Description
The summary details for the dataset.
Members
- arn
-
- Required: Yes
- Type: string
The ARN of the dataset. The format is
arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}
. - creationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The dataset creation date, in Unix epoch time.
- description
-
- Required: Yes
- Type: string
A description about the dataset, and its functionality.
- id
-
- Required: Yes
- Type: string
The ID of the dataset.
- lastUpdateDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the dataset was last updated, in Unix epoch time.
- name
-
- Required: Yes
- Type: string
The name of the dataset.
- status
-
- Required: Yes
- Type: DatasetStatus structure
The status of the dataset. This contains the state and any error messages. The state is
ACTIVE
when ready to use.
Datum
Description
Represents a single data point in a query result.
Members
- arrayValue
-
- Type: Array of Datum structures
Indicates if the data point is an array.
- nullValue
-
- Type: boolean
Indicates if the data point is null.
- rowValue
-
- Type: Row structure
Indicates if the data point is a row.
- scalarValue
-
- Type: string
Indicates if the data point is a scalar value such as integer, string, double, or Boolean.
DetailedError
Description
Contains detailed error information.
Members
- code
-
- Required: Yes
- Type: string
The error code.
- message
-
- Required: Yes
- Type: string
The error message.
ErrorDetails
Description
Contains the details of an IoT SiteWise error.
Members
- code
-
- Required: Yes
- Type: string
The error code.
- details
-
- Type: Array of DetailedError structures
A list of detailed errors.
- message
-
- Required: Yes
- Type: string
The error message.
ErrorReportLocation
Description
The Amazon S3 destination where errors associated with the job creation request are saved.
Members
- bucket
-
- Required: Yes
- Type: string
The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent.
- prefix
-
- Required: Yes
- Type: string
Amazon S3 uses the prefix as a folder name to organize data in the bucket. Each Amazon S3 object has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/). For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.
ExpressionVariable
Description
Contains expression variable information.
Members
- name
-
- Required: Yes
- Type: string
The friendly name of the variable to be used in the expression.
- value
-
- Required: Yes
- Type: VariableValue structure
The variable that identifies an asset property from which to use values.
File
Description
The file in Amazon S3 where your data is saved.
Members
- bucket
-
- Required: Yes
- Type: string
The name of the Amazon S3 bucket from which data is imported.
- key
-
- Required: Yes
- Type: string
The key of the Amazon S3 object that contains your data. Each object has a key that is a unique identifier. Each object has exactly one key.
- versionId
-
- Type: string
The version ID to identify a specific version of the Amazon S3 object that contains your data.
FileFormat
ForwardingConfig
Description
The forwarding configuration for a given property.
Members
- state
-
- Required: Yes
- Type: string
The forwarding state for the given property.
GatewayCapabilitySummary
Description
Contains a summary of a gateway capability configuration.
Members
- capabilityNamespace
-
- Required: Yes
- Type: string
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
, whereversion
is a number such as1
. - capabilitySyncStatus
-
- Required: Yes
- Type: 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. -
NOT_APPLICABLE
– Synchronization is not required for this capability configuration. This is most common when integrating partner data sources, because the data integration is handled externally by the partner. -
OUT_OF_SYNC
– The gateway hasn't received the capability configuration. -
SYNC_FAILED
– The gateway rejected the capability configuration. -
UNKNOWN
– The synchronization status is currently unknown due to an undetermined or temporary error.
GatewayPlatform
Description
Contains a gateway's platform information.
Members
- greengrass
-
- Type: Greengrass structure
A gateway that runs on IoT Greengrass.
- greengrassV2
-
- Type: GreengrassV2 structure
A gateway that runs on IoT Greengrass V2.
- siemensIE
-
- Type: SiemensIE structure
A SiteWise Edge gateway that runs on a Siemens Industrial Edge Device.
GatewaySummary
Description
Contains a summary of a gateway.
Members
- creationDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the gateway was created, in Unix epoch time.
- gatewayCapabilitySummaries
-
- Type: Array of GatewayCapabilitySummary structures
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.
- gatewayId
-
- Required: Yes
- Type: string
The ID of the gateway device.
- gatewayName
-
- Required: Yes
- Type: string
The name of the gateway.
- gatewayPlatform
-
- Type: GatewayPlatform structure
Contains a gateway's platform information.
- lastUpdateDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the gateway was last updated, in Unix epoch time.
Greengrass
Description
Contains details for a gateway that runs on IoT Greengrass. To create a gateway that runs on IoT Greengrass, you must add the IoT SiteWise connector to a Greengrass group and deploy it. Your Greengrass group must also have permissions to upload data to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide.
Members
- groupArn
-
- Required: Yes
- Type: string
The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the IoT Greengrass V1 API Reference.
GreengrassV2
Description
Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass V2, you must deploy the IoT SiteWise Edge component to your gateway device. Your Greengrass device role must use the AWSIoTSiteWiseEdgeAccess
policy. For more information, see Using IoT SiteWise at the edge in the IoT SiteWise User Guide.
Members
- coreDeviceThingName
-
- Required: Yes
- Type: string
The name of the IoT thing for your IoT Greengrass V2 core device.
GroupIdentity
Description
Contains information for a group identity in an access policy.
Members
- id
-
- Required: Yes
- Type: string
The IAM Identity Center ID of the group.
IAMRoleIdentity
IAMUserIdentity
Description
Contains information about an Identity and Access Management user.
Members
- arn
-
- Required: Yes
- Type: string
The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide.
If you delete the IAM user, access policies that contain this identity include an empty
arn
. You can delete the access policy for the IAM user that no longer exists.
Identity
Description
Contains an identity that can access an IoT SiteWise Monitor resource.
Currently, you can't use Amazon Web Services API operations to retrieve IAM Identity Center identity IDs. You can find the IAM Identity Center identity IDs in the URL of user and group pages in the IAM Identity Center console.
Members
- group
-
- Type: GroupIdentity structure
An IAM Identity Center group identity.
- iamRole
-
- Type: IAMRoleIdentity structure
An IAM role identity.
- iamUser
-
- Type: IAMUserIdentity structure
An IAM user identity.
- user
-
- Type: UserIdentity structure
An IAM Identity Center user identity.
Image
Description
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.
Members
- file
-
- Type: ImageFile structure
Contains an image file.
- id
-
- Type: string
The ID of an existing image. Specify this parameter to keep an existing image.
ImageFile
Description
Contains an image file.
Members
- data
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.
- type
-
- Required: Yes
- Type: string
The file type of the image.
ImageLocation
Description
Contains an image that is uploaded to IoT SiteWise and available at a URL.
Members
- id
-
- Required: Yes
- Type: string
The ID of the image.
- url
-
- Required: Yes
- Type: string
The URL where the image is available. The URL is valid for 15 minutes so that you can view and download the image
InternalFailureException
Description
IoT SiteWise can't process your request right now. Try again later.
Members
- message
-
- Required: Yes
- Type: string
InterpolatedAssetPropertyValue
Description
Contains information about an interpolated asset property value.
Members
- timestamp
-
- Required: Yes
- Type: Ti