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.
- BatchAssociateProjectAssets ( array $params = [] )
Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.
- BatchDisassociateProjectAssets ( array $params = [] )
Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.
- BatchPutAssetPropertyValue ( array $params = [] )
Sends a list of asset property values to AWS IoT SiteWise.
- CreateAccessPolicy ( array $params = [] )
Creates an access policy that grants the specified identity (AWS SSO user, AWS SSO group, or IAM user) access to the specified AWS 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.
- CreateDashboard ( array $params = [] )
Creates a dashboard in an AWS IoT SiteWise Monitor project.
- CreateGateway ( array $params = [] )
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS 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 AWS IoT SiteWise Monitor resource.
- DeleteAsset ( array $params = [] )
Deletes an asset.
- DeleteAssetModel ( array $params = [] )
Deletes an asset model.
- DeleteDashboard ( array $params = [] )
Deletes a dashboard from AWS IoT SiteWise Monitor.
- DeleteGateway ( array $params = [] )
Deletes a gateway from AWS IoT SiteWise.
- DeletePortal ( array $params = [] )
Deletes a portal from AWS IoT SiteWise Monitor.
- DeleteProject ( array $params = [] )
Deletes a project from AWS IoT SiteWise Monitor.
- DescribeAccessPolicy ( array $params = [] )
Describes an access policy, which specifies an identity's access to an AWS IoT SiteWise Monitor portal or project.
- DescribeAsset ( array $params = [] )
Retrieves information about an asset.
- DescribeAssetModel ( array $params = [] )
Retrieves information about an asset model.
- DescribeAssetProperty ( array $params = [] )
Retrieves information about an asset property.
- DescribeDashboard ( array $params = [] )
Retrieves information about a dashboard.
- DescribeDefaultEncryptionConfiguration ( array $params = [] )
Retrieves information about the default encryption configuration for the AWS 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 AWS IoT SiteWise logging options.
- DescribePortal ( array $params = [] )
Retrieves information about a portal.
- DescribeProject ( array $params = [] )
Retrieves information about a project.
- DisassociateAssets ( array $params = [] )
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
- 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.
- ListAccessPolicies ( array $params = [] )
Retrieves a paginated list of access policies for an identity (an AWS SSO user, an AWS SSO group, or an IAM user) or an AWS IoT SiteWise Monitor resource (a portal or project).
- ListAssetModels ( array $params = [] )
Retrieves a paginated list of summaries of all asset models.
- 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.
- ListDashboards ( array $params = [] )
Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
- ListGateways ( array $params = [] )
Retrieves a paginated list of gateways.
- ListPortals ( array $params = [] )
Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
- ListProjectAssets ( array $params = [] )
Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
- ListProjects ( array $params = [] )
Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
- ListTagsForResource ( array $params = [] )
Retrieves the list of tags for an AWS IoT SiteWise resource.
- PutDefaultEncryptionConfiguration ( array $params = [] )
Sets the default encryption configuration for the AWS account.
- PutLoggingOptions ( array $params = [] )
Sets logging options for AWS IoT SiteWise.
- TagResource ( array $params = [] )
Adds tags to an AWS IoT SiteWise resource.
- UntagResource ( array $params = [] )
Removes a tag from an AWS IoT SiteWise resource.
- UpdateAccessPolicy ( array $params = [] )
Updates an existing access policy that specifies an identity's access to an AWS 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.
- UpdateAssetProperty ( array $params = [] )
Updates an asset property's alias and notification state.
- UpdateDashboard ( array $params = [] )
Updates an AWS IoT SiteWise Monitor dashboard.
- 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 AWS IoT SiteWise Monitor portal.
- UpdateProject ( array $params = [] )
Updates an AWS 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:
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 AWS 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.
- childAssetId
-
- Required: Yes
- Type: string
The ID of the child asset to be associated.
- 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. 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 AWS IoT SiteWise User Guide.
Result Syntax
[]
Result Details
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
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 AWS IoT SiteWise User Guide.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS 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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
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 AWS IoT SiteWise User Guide.
BatchDisassociateProjectAssets
$result = $client->batchDisassociateProjectAssets
([/* ... */]); $promise = $client->batchDisassociateProjectAssetsAsync
([/* ... */]);
Disassociates a group (batch) of assets from an AWS 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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
BatchPutAssetPropertyValue
$result = $client->batchPutAssetPropertyValue
([/* ... */]); $promise = $client->batchPutAssetPropertyValueAsync
([/* ... */]);
Sends a list of asset property values to AWS IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the AWS 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, AWS IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 5 minutes in the future. AWS IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +5 minutes] and returns a TimestampOutOfRangeException
error.
For each asset property, AWS IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}
, then storing {T1, GOOD, V2}
replaces the existing TQV.
AWS IoT SiteWise authorizes access to each BatchPutAssetPropertyValue
entry individually. For more information, see BatchPutAssetPropertyValue authorization in the AWS 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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
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 AWS IoT SiteWise User Guide.
-
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 (AWS SSO user, AWS SSO group, or IAM user) access to the specified AWS IoT SiteWise Monitor portal or project resource.
Parameter Syntax
$result = $client->createAccessPolicy([ 'accessPolicyIdentity' => [ // REQUIRED 'group' => [ 'id' => '<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 AWS SSO user, an AWS SSO 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 AWS 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 AWS IoT SiteWise resources in the AWS 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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
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 AWS 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 AWS IoT SiteWise User Guide.
Parameter Syntax
$result = $client->createAsset([ 'assetModelId' => '<string>', // REQUIRED 'assetName' => '<string>', // REQUIRED 'clientToken' => '<string>', 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- assetModelId
-
- Required: Yes
- Type: string
The ID of the asset model from which to create the asset.
- assetName
-
- Required: Yes
- Type: string
A unique, 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 AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
Result Syntax
[ 'assetArn' => '<string>', 'assetId' => '<string>', 'assetStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', '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. This ID uniquely identifies the asset within AWS IoT SiteWise and can be used with other AWS IoT SiteWise APIs.
- 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
-
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.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
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 AWS 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 AWS IoT SiteWise User Guide.
Parameter Syntax
$result = $client->createAssetModel([ 'assetModelCompositeModels' => [ [ 'description' => '<string>', 'name' => '<string>', // REQUIRED 'properties' => [ [ 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', // REQUIRED 'dataTypeSpec' => '<string>', 'name' => '<string>', // REQUIRED 'type' => [ // REQUIRED 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ ], 'metric' => [ 'expression' => '<string>', // REQUIRED 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', // REQUIRED ], ], // ... ], 'window' => [ // REQUIRED 'tumbling' => [ 'interval' => '<string>', // REQUIRED ], ], ], 'transform' => [ 'expression' => '<string>', // REQUIRED 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', // REQUIRED ], ], // ... ], ], ], 'unit' => '<string>', ], // ... ], 'type' => '<string>', // REQUIRED ], // ... ], 'assetModelDescription' => '<string>', 'assetModelHierarchies' => [ [ 'childAssetModelId' => '<string>', // REQUIRED 'name' => '<string>', // REQUIRED ], // ... ], 'assetModelName' => '<string>', // REQUIRED 'assetModelProperties' => [ [ 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', // REQUIRED 'dataTypeSpec' => '<string>', 'name' => '<string>', // REQUIRED 'type' => [ // REQUIRED 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ ], 'metric' => [ 'expression' => '<string>', // REQUIRED 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', // REQUIRED ], ], // ... ], 'window' => [ // REQUIRED 'tumbling' => [ 'interval' => '<string>', // REQUIRED ], ], ], 'transform' => [ 'expression' => '<string>', // REQUIRED 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', // REQUIRED ], ], // ... ], ], ], 'unit' => '<string>', ], // ... ], 'clientToken' => '<string>', 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- assetModelCompositeModels
-
- Type: Array of AssetModelCompositeModelDefinition structures
The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.
- assetModelDescription
-
- Type: string
A description for the asset model.
- 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 AWS IoT SiteWise User Guide.
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
- assetModelName
-
- Required: Yes
- Type: string
A unique, friendly 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 AWS IoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS 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.
- 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 AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
Result Syntax
[ 'assetModelArn' => '<string>', 'assetModelId' => '<string>', 'assetModelStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', '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. You can use this ID when you call other AWS IoT SiteWise APIs.
- 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
-
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.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
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 AWS 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 AWS 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. For detailed information, see Creating dashboards (CLI) in the AWS 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 AWS IoT SiteWise resources in the AWS 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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
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 AWS IoT SiteWise User Guide.
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 AWS IoT SiteWise. For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide.
Parameter Syntax
$result = $client->createGateway([ 'gatewayName' => '<string>', // REQUIRED 'gatewayPlatform' => [ // REQUIRED 'greengrass' => [ // REQUIRED 'groupArn' => '<string>', // REQUIRED ], ], 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- gatewayName
-
- Required: Yes
- Type: string
A unique, friendly 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 AWS IoT SiteWise resources in the AWS 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 AWS IoT SiteWise APIs.
Errors
-
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.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
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 AWS IoT SiteWise User Guide.
CreatePortal
$result = $client->createPortal
([/* ... */]); $promise = $client->createPortalAsync
([/* ... */]);
Creates a portal, which can contain projects and dashboards. AWS IoT SiteWise Monitor uses AWS SSO or IAM to authenticate portal users and manage user permissions.
Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the AWS IoT SiteWise User Guide.
Parameter Syntax
$result = $client->createPortal([ 'clientToken' => '<string>', 'portalAuthMode' => 'IAM|SSO', 'portalContactEmail' => '<string>', // REQUIRED 'portalDescription' => '<string>', 'portalLogoImageFile' => [ 'data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'type' => 'PNG', // REQUIRED ], 'portalName' => '<string>', // REQUIRED 'roleArn' => '<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.
- portalAuthMode
-
- Type: string
The service to use to authenticate users to the portal. Choose from the following options:
-
SSO
– The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide. This option is only available in AWS Regions other than the China Regions. -
IAM
– The portal uses AWS Identity and Access Management (IAM) to authenticate users and manage user permissions. This option is only available in the China Regions.
You can't change this value after you create a portal.
Default:
SSO
- portalContactEmail
-
- Required: Yes
- Type: string
The AWS 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.
- roleArn
-
- Required: Yes
- Type: string
The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS 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 AWS IoT SiteWise resources in the AWS 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|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 AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the AWS 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 AWS SSO application ID, if the portal uses AWS SSO.
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
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 AWS IoT SiteWise User Guide.
CreateProject
$result = $client->createProject
([/* ... */]); $promise = $client->createProjectAsync
([/* ... */]);
Creates a project in the specified portal.
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 AWS IoT SiteWise resources in the AWS 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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
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 AWS IoT SiteWise User Guide.
DeleteAccessPolicy
$result = $client->deleteAccessPolicy
([/* ... */]); $promise = $client->deleteAccessPolicyAsync
([/* ... */]);
Deletes an access policy that grants the specified identity access to the specified AWS IoT SiteWise Monitor resource. You can use this operation to revoke access to an AWS IoT SiteWise Monitor resource.
Parameter Syntax
$result = $client->deleteAccessPolicy([ 'accessPolicyId' => '<string>', // REQUIRED 'clientToken' => '<string>', ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS 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
Result Syntax
[ 'assetStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', '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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise User Guide.
Parameter Syntax
$result = $client->deleteAssetModel([ 'assetModelId' => '<string>', // REQUIRED 'clientToken' => '<string>', ]);
Parameter Details
Members
Result Syntax
[ 'assetModelStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', '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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.
DeleteDashboard
$result = $client->deleteDashboard
([/* ... */]); $promise = $client->deleteDashboardAsync
([/* ... */]);
Deletes a dashboard from AWS IoT SiteWise Monitor.
Parameter Syntax
$result = $client->deleteDashboard([ 'clientToken' => '<string>', 'dashboardId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
DeleteGateway
$result = $client->deleteGateway
([/* ... */]); $promise = $client->deleteGatewayAsync
([/* ... */]);
Deletes a gateway from AWS IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.
Parameter Syntax
$result = $client->deleteGateway([ 'gatewayId' => '<string>', // REQUIRED ]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
DeletePortal
$result = $client->deletePortal
([/* ... */]); $promise = $client->deletePortalAsync
([/* ... */]);
Deletes a portal from AWS IoT SiteWise Monitor.
Parameter Syntax
$result = $client->deletePortal([ 'clientToken' => '<string>', 'portalId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'portalStatus' => [ 'error' => [ 'code' => 'INTERNAL_FAILURE|VALIDATION_ERROR|LIMIT_EXCEEDED', 'message' => '<string>', ], 'state' => 'CREATING|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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise Monitor.
Parameter Syntax
$result = $client->deleteProject([ 'clientToken' => '<string>', 'projectId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
DescribeAccessPolicy
$result = $client->describeAccessPolicy
([/* ... */]); $promise = $client->describeAccessPolicyAsync
([/* ... */]);
Describes an access policy, which specifies an identity's access to an AWS IoT SiteWise Monitor portal or project.
Parameter Syntax
$result = $client->describeAccessPolicy([ 'accessPolicyId' => '<string>', // REQUIRED ]);
Parameter Details
Result Syntax
[ 'accessPolicyArn' => '<string>', 'accessPolicyCreationDate' => <DateTime>, 'accessPolicyId' => '<string>', 'accessPolicyIdentity' => [ 'group' => [ 'id' => '<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 (AWS SSO user, AWS SSO 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 AWS IoT SiteWise Monitor resource (portal or project) to which this access policy provides access.
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
DescribeAsset
$result = $client->describeAsset
([/* ... */]); $promise = $client->describeAssetAsync
([/* ... */]);
Retrieves information about an asset.
Parameter Syntax
$result = $client->describeAsset([ 'assetId' => '<string>', // REQUIRED ]);
Parameter Details
Result Syntax
[ 'assetArn' => '<string>', 'assetCompositeModels' => [ [ 'description' => '<string>', 'name' => '<string>', 'properties' => [ [ 'alias' => '<string>', 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', 'dataTypeSpec' => '<string>', 'id' => '<string>', 'name' => '<string>', 'notification' => [ 'state' => 'ENABLED|DISABLED', 'topic' => '<string>', ], 'unit' => '<string>', ], // ... ], 'type' => '<string>', ], // ... ], 'assetCreationDate' => <DateTime>, 'assetHierarchies' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'assetId' => '<string>', 'assetLastUpdateDate' => <DateTime>, 'assetModelId' => '<string>', 'assetName' => '<string>', 'assetProperties' => [ [ 'alias' => '<string>', 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', 'dataTypeSpec' => '<string>', 'id' => '<string>', 'name' => '<string>', 'notification' => [ 'state' => 'ENABLED|DISABLED', 'topic' => '<string>', ], 'unit' => '<string>', ], // ... ], 'assetStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', '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}
- 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.
- 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.
- 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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 ]);
Parameter Details
Result Syntax
[ 'assetModelArn' => '<string>', 'assetModelCompositeModels' => [ [ 'description' => '<string>', 'name' => '<string>', 'properties' => [ [ 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', 'dataTypeSpec' => '<string>', 'id' => '<string>', 'name' => '<string>', 'type' => [ 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ ], 'metric' => [ 'expression' => '<string>', 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', ], ], // ... ], 'window' => [ 'tumbling' => [ 'interval' => '<string>', ], ], ], 'transform' => [ 'expression' => '<string>', 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', ], ], // ... ], ], ], 'unit' => '<string>', ], // ... ], 'type' => '<string>', ], // ... ], 'assetModelCreationDate' => <DateTime>, 'assetModelDescription' => '<string>', 'assetModelHierarchies' => [ [ 'childAssetModelId' => '<string>', 'id' => '<string>', 'name' => '<string>', ], // ... ], 'assetModelId' => '<string>', 'assetModelLastUpdateDate' => <DateTime>, 'assetModelName' => '<string>', 'assetModelProperties' => [ [ 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', 'dataTypeSpec' => '<string>', 'id' => '<string>', 'name' => '<string>', 'type' => [ 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ ], 'metric' => [ 'expression' => '<string>', 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', ], ], // ... ], 'window' => [ 'tumbling' => [ 'interval' => '<string>', ], ], ], 'transform' => [ 'expression' => '<string>', 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', ], ], // ... ], ], ], 'unit' => '<string>', ], // ... ], 'assetModelStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', '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}
- assetModelCompositeModels
-
- Type: Array of AssetModelCompositeModel structures
The list of composite asset models for the asset model.
- 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.
- 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.
- 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.
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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
Result Syntax
[ 'assetId' => '<string>', 'assetModelId' => '<string>', 'assetName' => '<string>', 'assetProperty' => [ 'alias' => '<string>', 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', 'id' => '<string>', 'name' => '<string>', 'notification' => [ 'state' => 'ENABLED|DISABLED', 'topic' => '<string>', ], 'type' => [ 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ ], 'metric' => [ 'expression' => '<string>', 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', ], ], // ... ], 'window' => [ 'tumbling' => [ 'interval' => '<string>', ], ], ], 'transform' => [ 'expression' => '<string>', 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', ], ], // ... ], ], ], 'unit' => '<string>', ], 'compositeModel' => [ 'assetProperty' => [ 'alias' => '<string>', 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', 'id' => '<string>', 'name' => '<string>', 'notification' => [ 'state' => 'ENABLED|DISABLED', 'topic' => '<string>', ], 'type' => [ 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ ], 'metric' => [ 'expression' => '<string>', 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', ], ], // ... ], 'window' => [ 'tumbling' => [ 'interval' => '<string>', ], ], ], 'transform' => [ 'expression' => '<string>', 'variables' => [ [ 'name' => '<string>', 'value' => [ 'hierarchyId' => '<string>', 'propertyId' => '<string>', ], ], // ... ], ], ], 'unit' => '<string>', ], 'name' => '<string>', 'type' => '<string>', ], ]
Result Details
Members
- assetId
-
- Required: Yes
- Type: string
The ID of the asset.
- assetModelId
-
- Required: Yes
- Type: string
The ID of the asset model.
- 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 asset model that declares this asset property, if this asset property exists in a composite model.
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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
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 AWS 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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
DescribeDefaultEncryptionConfiguration
$result = $client->describeDefaultEncryptionConfiguration
([/* ... */]); $promise = $client->describeDefaultEncryptionConfigurationAsync
([/* ... */]);
Retrieves information about the default encryption configuration for the AWS account in the default or specified region. For more information, see Key management in the AWS 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 customer master key (CMK) used for AWS KMS encryption if you use
KMS_BASED_ENCRYPTION
.
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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
Result Syntax
[ 'creationDate' => <DateTime>, 'gatewayArn' => '<string>', 'gatewayCapabilitySummaries' => [ [ 'capabilityNamespace' => '<string>', 'capabilitySyncStatus' => 'IN_SYNC|OUT_OF_SYNC|SYNC_FAILED', ], // ... ], 'gatewayId' => '<string>', 'gatewayName' => '<string>', 'gatewayPlatform' => [ 'greengrass' => [ 'groupArn' => '<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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
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 AWS 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', '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 AWS 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. -
OUT_OF_SYNC
– The gateway hasn't received the capability configuration. -
SYNC_FAILED
– The gateway rejected the capability configuration.
- gatewayId
-
- Required: Yes
- Type: string
The ID of the gateway that defines the capability configuration.
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
DescribeLoggingOptions
$result = $client->describeLoggingOptions
([/* ... */]); $promise = $client->describeLoggingOptionsAsync
([/* ... */]);
Retrieves the current AWS 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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
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
Result Syntax
[ '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|UPDATING|DELETING|ACTIVE|FAILED', ], 'roleArn' => '<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}
- portalAuthMode
-
- Type: string
The service to use to authenticate users to the portal.
- portalClientId
-
- Required: Yes
- Type: string
The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes
portalClientId
for only portals that use AWS SSO to authenticate users. - portalContactEmail
-
- Required: Yes
- Type: string
The AWS 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 AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the AWS 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.
- roleArn
-
- Type: string
The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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
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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.
- childAssetId
-
- Required: Yes
- Type: string
The ID of the child asset to disassociate.
- 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. 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 AWS IoT SiteWise User Guide.
Result Syntax
[]
Result Details
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.
GetAssetPropertyAggregates
$result = $client->getAssetPropertyAggregates
([/* ... */]); $promise = $client->getAssetPropertyAggregatesAsync
([/* ... */]);
Gets aggregated values for an asset property. For more information, see Querying aggregates in the AWS 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.
- 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 be returned per paginated request.
Default: 100
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
- propertyAlias
-
- Type: string
The property alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide. - propertyId
-
- Type: string
The ID of the asset property.
- 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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
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 AWS 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.
- propertyAlias
-
- Type: string
The property alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide. - propertyId
-
- Type: string
The ID of the asset property.
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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
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 AWS 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.
- 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 be returned per paginated request.
Default: 100
- nextToken
-
- Type: string
The token to be used for the next set of paginated results.
- propertyAlias
-
- Type: string
The property alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide. - propertyId
-
- Type: string
The ID of the asset property.
- 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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
The requested service is unavailable.
ListAccessPolicies
$result = $client->listAccessPolicies
([/* ... */]); $promise = $client->listAccessPoliciesAsync
([/* ... */]);
Retrieves a paginated list of access policies for an identity (an AWS SSO user, an AWS SSO group, or an IAM user) or an AWS 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 (AWS SSO user, AWS SSO group, or IAM user). This parameter is required if you specify
identityId
. - maxResults
-
- Type: int
The maximum number of results to be returned per 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>', ], '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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
Result Syntax
[ 'assetModelSummaries' => [ [ 'arn' => '<string>', 'creationDate' => <DateTime>, 'description' => '<string>', 'id' => '<string>', 'lastUpdateDate' => <DateTime>, 'name' => '<string>', 'status' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', 'message' => '<string>', ], 'state' => 'CREATING|ACTIVE|UPDATING|PROPAGATING|DELETING|FAILED', ], ], // ... ], '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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.
- maxResults
-
- Type: int
The maximum number of results to be returned per 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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
The requested resource can't be found.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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
. - 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 be returned per 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>, 'hierarchies' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'id' => '<string>', 'lastUpdateDate' => <DateTime>, 'name' => '<string>', 'status' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', '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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
The requested resource can't be found.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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:
-
List child assets associated to a parent asset by a hierarchy that you specify.
-
List an 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.
- hierarchyId
-
- Type: string
The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose
CHILD
fortraversalDirection
.For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.
- maxResults
-
- Type: int
The maximum number of results to be returned per 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. ThehierarchyId
parameter is required if you chooseCHILD
. -
PARENT
– The list includes the asset's parent asset.
Default:
CHILD
Result Syntax
[ 'assetSummaries' => [ [ 'arn' => '<string>', 'assetModelId' => '<string>', 'creationDate' => <DateTime>, 'hierarchies' => [ [ 'id' => '<string>', 'name' => '<string>', ], // ... ], 'id' => '<string>', 'lastUpdateDate' => <DateTime>, 'name' => '<string>', 'status' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', '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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
The requested resource can't be found.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
ListDashboards
$result = $client->listDashboards
([/* ... */]); $promise = $client->listDashboardsAsync
([/* ... */]);
Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
Parameter Syntax
$result = $client->listDashboards([ 'maxResults' => <integer>, 'nextToken' => '<string>', 'projectId' => '<string>', // REQUIRED ]);
Parameter Details
Members
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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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
Result Syntax
[ 'gatewaySummaries' => [ [ 'creationDate' => <DateTime>, 'gatewayCapabilitySummaries' => [ [ 'capabilityNamespace' => '<string>', 'capabilitySyncStatus' => 'IN_SYNC|OUT_OF_SYNC|SYNC_FAILED', ], // ... ], 'gatewayId' => '<string>', 'gatewayName' => '<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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
ListPortals
$result = $client->listPortals
([/* ... */]); $promise = $client->listPortalsAsync
([/* ... */]);
Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
Parameter Syntax
$result = $client->listPortals([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
Result Syntax
[ 'nextToken' => '<string>', 'portalSummaries' => [ [ 'creationDate' => <DateTime>, 'description' => '<string>', 'id' => '<string>', 'lastUpdateDate' => <DateTime>, 'name' => '<string>', 'roleArn' => '<string>', 'startUrl' => '<string>', 'status' => [ 'error' => [ 'code' => 'INTERNAL_FAILURE|VALIDATION_ERROR|LIMIT_EXCEEDED', 'message' => '<string>', ], 'state' => 'CREATING|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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
ListProjectAssets
$result = $client->listProjectAssets
([/* ... */]); $promise = $client->listProjectAssetsAsync
([/* ... */]);
Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
Parameter Syntax
$result = $client->listProjectAssets([ 'maxResults' => <integer>, 'nextToken' => '<string>', 'projectId' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'assetIds' => ['<string>', ...], 'nextToken' => '<string>', ]
Result Details
Members
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
ListProjects
$result = $client->listProjects
([/* ... */]); $promise = $client->listProjectsAsync
([/* ... */]);
Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
Parameter Syntax
$result = $client->listProjects([ 'maxResults' => <integer>, 'nextToken' => '<string>', 'portalId' => '<string>', // REQUIRED ]);
Parameter Details
Members
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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Retrieves the list of tags for an AWS 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 AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
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.
-
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 AWS IoT SiteWise User Guide.
-
You are not authorized.
PutDefaultEncryptionConfiguration
$result = $client->putDefaultEncryptionConfiguration
([/* ... */]); $promise = $client->putDefaultEncryptionConfigurationAsync
([/* ... */]);
Sets the default encryption configuration for the AWS account. For more information, see Key management in the AWS IoT SiteWise User Guide.
Parameter Syntax
$result = $client->putDefaultEncryptionConfiguration([ 'encryptionType' => 'SITEWISE_DEFAULT_ENCRYPTION|KMS_BASED_ENCRYPTION', // REQUIRED 'kmsKeyId' => '<string>', ]);
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 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 AWS KMS CMK used for AWS KMS encryption if you use
KMS_BASED_ENCRYPTION
.
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
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 AWS 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 AWS 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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
AWS 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.
-
The requested resource can't be found.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Adds tags to an AWS 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 AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
Result Syntax
[]
Result Details
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
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.
-
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 AWS IoT SiteWise User Guide.
-
You are not authorized.
-
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 AWS General Reference.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes a tag from an AWS 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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
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.
-
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 AWS IoT SiteWise User Guide.
-
You are not authorized.
UpdateAccessPolicy
$result = $client->updateAccessPolicy
([/* ... */]); $promise = $client->updateAccessPolicyAsync
([/* ... */]);
Updates an existing access policy that specifies an identity's access to an AWS IoT SiteWise Monitor portal or project resource.
Parameter Syntax
$result = $client->updateAccessPolicy([ 'accessPolicyId' => '<string>', // REQUIRED 'accessPolicyIdentity' => [ // REQUIRED 'group' => [ 'id' => '<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 AWS SSO user, an AWS SSO 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 AWS 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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise User Guide.
Parameter Syntax
$result = $client->updateAsset([ 'assetId' => '<string>', // REQUIRED 'assetName' => '<string>', // REQUIRED 'clientToken' => '<string>', ]);
Parameter Details
Members
- assetId
-
- Required: Yes
- Type: string
The ID of the asset to update.
- assetName
-
- Required: Yes
- Type: string
A unique, 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', '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
-
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.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise User Guide.
This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel.
If you remove a property from an asset model, AWS IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, AWS IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.
Parameter Syntax
$result = $client->updateAssetModel([ 'assetModelCompositeModels' => [ [ 'description' => '<string>', 'name' => '<string>', // REQUIRED 'properties' => [ [ 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', // REQUIRED 'dataTypeSpec' => '<string>', 'id' => '<string>', 'name' => '<string>', // REQUIRED 'type' => [ // REQUIRED 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ ], 'metric' => [ 'expression' => '<string>', // REQUIRED 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', // REQUIRED ], ], // ... ], 'window' => [ // REQUIRED 'tumbling' => [ 'interval' => '<string>', // REQUIRED ], ], ], 'transform' => [ 'expression' => '<string>', // REQUIRED 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', // REQUIRED ], ], // ... ], ], ], 'unit' => '<string>', ], // ... ], 'type' => '<string>', // REQUIRED ], // ... ], 'assetModelDescription' => '<string>', 'assetModelHierarchies' => [ [ 'childAssetModelId' => '<string>', // REQUIRED 'id' => '<string>', 'name' => '<string>', // REQUIRED ], // ... ], 'assetModelId' => '<string>', // REQUIRED 'assetModelName' => '<string>', // REQUIRED 'assetModelProperties' => [ [ 'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', // REQUIRED 'dataTypeSpec' => '<string>', 'id' => '<string>', 'name' => '<string>', // REQUIRED 'type' => [ // REQUIRED 'attribute' => [ 'defaultValue' => '<string>', ], 'measurement' => [ ], 'metric' => [ 'expression' => '<string>', // REQUIRED 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', // REQUIRED ], ], // ... ], 'window' => [ // REQUIRED 'tumbling' => [ 'interval' => '<string>', // REQUIRED ], ], ], 'transform' => [ 'expression' => '<string>', // REQUIRED 'variables' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'hierarchyId' => '<string>', 'propertyId' => '<string>', // REQUIRED ], ], // ... ], ], ], 'unit' => '<string>', ], // ... ], 'clientToken' => '<string>', ]);
Parameter Details
Members
- assetModelCompositeModels
-
- Type: Array of AssetModelCompositeModel structures
The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.
- assetModelDescription
-
- Type: string
A description for the asset model.
- 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 AWS IoT SiteWise User Guide.
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
- assetModelId
-
- Required: Yes
- Type: string
The ID of the asset model to update.
- assetModelName
-
- Required: Yes
- Type: string
A unique, friendly 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 AWS IoT SiteWise User Guide.
You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS 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
[ 'assetModelStatus' => [ 'error' => [ 'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE', '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
-
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.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
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 AWS IoT SiteWise User Guide.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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.
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', ]);
Parameter Details
Members
- assetId
-
- Required: Yes
- Type: string
The ID of the asset to be updated.
- 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 property alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more information, see Mapping industrial data streams to asset properties in the AWS 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.
- propertyNotificationState
-
- Type: string
The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the AWS IoT SiteWise User Guide.
If you omit this parameter, the notification state is set to
DISABLED
.
Result Syntax
[]
Result Details
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS 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. For detailed information, see Creating dashboards (CLI) in the AWS 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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
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
Result Syntax
[]
Result Details
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
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.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
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 AWS 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 AWS 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', ]
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. -
OUT_OF_SYNC
– The gateway hasn't received the capability configuration. -
SYNC_FAILED
– The gateway rejected the capability configuration.
After you update a capability configuration, its sync status is
OUT_OF_SYNC
until the gateway receives and applies or rejects the updated configuration.
Errors
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
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.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
-
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 AWS IoT SiteWise User Guide.
UpdatePortal
$result = $client->updatePortal
([/* ... */]); $promise = $client->updatePortalAsync
([/* ... */]);
Updates an AWS IoT SiteWise Monitor portal.
Parameter Syntax
$result = $client->updatePortal([ 'clientToken' => '<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 'roleArn' => '<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.
- portalContactEmail
-
- Required: Yes
- Type: string
The AWS 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.
- roleArn
-
- Required: Yes
- Type: string
The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.
Result Syntax
[ 'portalStatus' => [ 'error' => [ 'code' => 'INTERNAL_FAILURE|VALIDATION_ERROR|LIMIT_EXCEEDED', 'message' => '<string>', ], 'state' => 'CREATING|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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS 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 AWS 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
-
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
The requested resource can't be found.
-
AWS IoT SiteWise can't process your request right now. Try again later.
-
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
Shapes
AccessPolicySummary
Description
Contains an access policy that defines an identity's access to an AWS 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 AWS SSO user, an AWS SSO 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 AWS IoT SiteWise Monitor resource (a portal or project).
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.
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.
- 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
.
AssetErrorDetails
Description
Contains error details for the requested associate project asset action.
Members
AssetHierarchy
Description
Describes an asset hierarchy that contains a hierarchy's name and ID.
Members
- 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
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.
- 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.
- 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
.
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. All assets in this hierarchy must be instances of the
childAssetModelId
asset model. - id
-
- Type: string
The ID of the asset model hierarchy. This ID is a
hierarchyId
. - 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.
- 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.
- dataTypeSpec
-
- Type: string
The data type of the structure for this property. This parameter exists on properties that have the
STRUCT
data type. - id
-
- Type: string
The ID of the asset model property.
- name
-
- Required: Yes
- Type: string
The name of the asset model property.
- 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. - 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
.
AssetModelStatus
Description
Contains current status information for an asset model. For more information, see Asset and model states in the AWS 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}
- 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.
- id
-
- Required: Yes
- Type: string
The ID of the asset model (used with AWS IoT SiteWise APIs).
- 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.
AssetProperty
Description
Contains asset property information.
Members
- alias
-
- Type: string
The property alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more information, see Mapping industrial data streams to asset properties in the AWS 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. - 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.
- unit
-
- Type: string
The unit (such as
Newtons
orRPM
) 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 AWS 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.
- 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.
- 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.
- 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.
- 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 AWS 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 AWS IoT SiteWise User Guide.
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.
CompositeModelProperty
Description
Contains information about a composite model property on an asset.
Members
- assetProperty
-
- Required: Yes
- Type: Property structure
Contains asset property information.
- 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.
ConfigurationErrorDetails
Description
Contains the details of an AWS IoT SiteWise configuration error.
Members
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
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
ErrorDetails
Description
Contains the details of an AWS IoT SiteWise error.
Members
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.
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 AWS 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. -
OUT_OF_SYNC
– The gateway hasn't received the capability configuration. -
SYNC_FAILED
– The gateway rejected the capability configuration.
GatewayPlatform
Description
Contains a gateway's platform information.
Members
- greengrass
-
- Required: Yes
- Type: Greengrass structure
A gateway that runs on AWS IoT Greengrass.
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 asset.
- 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 AWS IoT Greengrass. To create a gateway that runs on AWS IoT Greengrass, you must add the IoT SiteWise connector to a Greengrass group and deploy it. Your Greengrass group must also have permissions to upload data to AWS IoT SiteWise. For more information, see Ingesting data using a gateway in the AWS 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 AWS IoT Greengrass API Reference.
GroupIdentity
Description
Contains information for a group identity in an access policy.
Members
IAMUserIdentity
Description
Contains information about an AWS Identity and Access Management (IAM) 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 AWS IoT SiteWise Monitor resource.
Currently, you can't use AWS APIs to retrieve AWS SSO identity IDs. You can find the AWS SSO identity IDs in the URL of user and group pages in the AWS SSO console.
Members
- group
-
- Type: GroupIdentity structure
An AWS SSO group identity.
- iamUser
-
- Type: IAMUserIdentity structure
An IAM user identity.
- user
-
- Type: UserIdentity structure
An AWS SSO 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
ImageLocation
Description
Contains an image that is uploaded to AWS IoT SiteWise and available at a URL.
Members
InternalFailureException
Description
AWS IoT SiteWise can't process your request right now. Try again later.
Members
InvalidRequestException
Description
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
Members
LimitExceededException
Description
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 AWS IoT SiteWise User Guide.
Members
LoggingOptions
Description
Contains logging options.
Members
Measurement
Description
Contains an asset measurement property. This structure is empty. For more information, see Measurements in the AWS IoT SiteWise User Guide.
Members
Metric
Description
Contains an asset metric property. With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum).
The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a root metric can have up to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of DOUBLE
and consume properties with data types of INTEGER
or DOUBLE
.
For more information, see Metrics in the AWS IoT SiteWise User Guide.
Members
- expression
-
- Required: Yes
- Type: string
The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
- variables
-
- Required: Yes
- Type: Array of ExpressionVariable structures
The list of variables used in the expression.
- window
-
- Required: Yes
- Type: MetricWindow structure
The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT SiteWise computes one data point per
window
.
MetricWindow
Description
Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).
Members
- tumbling
-
- Type: TumblingWindow structure
The tumbling time interval window.
MonitorErrorDetails
Description
Contains AWS IoT SiteWise Monitor error details.
Members
PortalResource
Description
Identifies an AWS IoT SiteWise Monitor portal.
Members
PortalStatus
Description
Contains information about the current status of a portal.
Members
- error
-
- Type: MonitorErrorDetails structure
Contains associated error information, if any.
- state
-
- Required: Yes
- Type: string
The current state of the portal.
PortalSummary
Description
Contains a portal summary.
Members
- creationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the portal was created, in Unix epoch time.
- description
-
- Type: string
The portal's description.
- id
-
- Required: Yes
- Type: string
The ID of the portal.
- lastUpdateDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the portal was last updated, in Unix epoch time.
- name
-
- Required: Yes
- Type: string
The name of the portal.
- roleArn
-
- Type: string
The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.
- startUrl
-
- Required: Yes
- Type: string
The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the AWS IoT SiteWise console to get a URL that you can use to access the portal.
- status
-
- Required: Yes
- Type: PortalStatus structure
Contains information about the current status of a portal.
ProjectResource
Description
Identifies a specific AWS IoT SiteWise Monitor project.
Members
ProjectSummary
Description
Contains project summary information.
Members
- creationDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the project was created, in Unix epoch time.
- description
-
- Type: string
The project's description.
- id
-
- Required: Yes
- Type: string
The ID of the project.
- lastUpdateDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date the project was last updated, in Unix epoch time.
- name
-
- Required: Yes
- Type: string
The name of the project.
Property
Description
Contains asset property information.
Members
- alias
-
- Type: string
The property alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide. - dataType
-
- Required: Yes
- Type: string
The property data type.
- 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.
- type
-
- Type: PropertyType structure
The property type (see
PropertyType
). A property contains one type. - unit
-
- Type: string
The unit (such as
Newtons
orRPM
) of the asset property.
PropertyNotification
Description
Contains asset property value notification information. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the AWS IoT SiteWise User Guide.
Members
PropertyType
Description
Contains a property type, which can be one of attribute
, measurement
, metric
, or transform
.
Members
- attribute
-
- Type: Attribute structure
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
- measurement
-
- Type: Measurement structure
Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
- metric
-
- Type: Metric structure
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
- transform
-
- Type: Transform structure
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
PutAssetPropertyValueEntry
Description
Contains a list of value updates for an asset property in the list of asset entries consumed by the BatchPutAssetPropertyValue API operation.
Members
- assetId
-
- Type: string
The ID of the asset to update.
- entryId
-
- Required: Yes
- Type: string
The user specified ID for the entry. You can use this ID to identify which entries failed.
- propertyAlias
-
- Type: string
The property alias that identifies the property, such as an OPC-UA server data stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide. - propertyId
-
- Type: string
The ID of the asset property for this entry.
- propertyValues
-
- Required: Yes
- Type: Array of AssetPropertyValue structures
The list of property values to upload. You can specify up to 10
propertyValues
array elements.
Resource
Description
Contains an AWS IoT SiteWise Monitor resource ID for a portal or project.
Members
- portal
-
- Type: PortalResource structure
A portal resource.
- project
-
- Type: ProjectResource structure
A project resource.
ResourceAlreadyExistsException
Description
The resource already exists.
Members
ResourceNotFoundException
ServiceUnavailableException
ThrottlingException
Description
Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
Members
TimeInNanos
Description
Contains a timestamp with optional nanosecond granularity.
Members
TooManyTagsException
Description
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 AWS General Reference.
Members
Transform
Description
Contains an asset transform property. A transform is a one-to-one mapping of a property's data points from one form to another. For example, you can use a transform to convert a Celsius data stream to Fahrenheit by applying the transformation expression to each data point of the Celsius stream. A transform can only have a data type of DOUBLE
and consume properties with data types of INTEGER
or DOUBLE
.
For more information, see Transforms in the AWS IoT SiteWise User Guide.
Members
- expression
-
- Required: Yes
- Type: string
The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.
For more information, see Quotas in the AWS IoT SiteWise User Guide.
- variables
-
- Required: Yes
- Type: Array of ExpressionVariable structures
The list of variables used in the expression.
TumblingWindow
Description
Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time interval. This window is used in metric and aggregation computations.
Members
- interval
-
- Required: Yes
- Type: string
The time interval for the tumbling window. Note that
w
represents weeks,d
represents days,h
represents hours, andm
represents minutes. AWS IoT SiteWise computes the1w
interval the end of Sunday at midnight each week (UTC), the1d
interval at the end of each day at midnight (UTC), the1h
interval at the end of each hour, and so on.When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.
UnauthorizedException
UserIdentity
Description
Contains information for a user identity in an access policy.
Members
VariableValue
Description
Identifies a property value used in an expression.
Members
- hierarchyId
-
- Type: string
The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.
You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same
propertyId
. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide. - propertyId
-
- Required: Yes
- Type: string
The ID of the property to use as the variable. You can use the property
name
if it's from the same asset model.
Variant
Description
Contains an asset property value (of a single type only).
Members
- booleanValue
-
- Type: boolean
Asset property data of type Boolean (true or false).
- doubleValue
-
- Type: double
Asset property data of type double (floating point number).
- integerValue
-
- Type: int
Asset property data of type integer (whole number).
- stringValue
-
- Type: string
Asset property data of type string (sequence of characters).