AssociateAssets

$result = $client->associateAssets([/* ... */]);
$promise = $client->associateAssetsAsync([/* ... */]);

Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide.

Parameter Syntax

$result = $client->associateAssets([
    'assetId' => '<string>', // REQUIRED
    'childAssetId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'hierarchyId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceAlreadyExistsException:

The resource already exists.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

LimitExceededException:

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the IoT SiteWise User Guide.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

ConflictingOperationException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

AssociateTimeSeriesToAssetProperty

$result = $client->associateTimeSeriesToAssetProperty([/* ... */]);
$promise = $client->associateTimeSeriesToAssetPropertyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->associateTimeSeriesToAssetProperty([
    'alias' => '<string>', // REQUIRED
    'assetId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'propertyId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

ConflictingOperationException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

BatchAssociateProjectAssets

$result = $client->batchAssociateProjectAssets([/* ... */]);
$promise = $client->batchAssociateProjectAssetsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchAssociateProjectAssets([
    'assetIds' => ['<string>', ...], // REQUIRED
    'clientToken' => '<string>',
    'projectId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'assetId' => '<string>',
            'code' => 'INTERNAL_FAILURE',
            'message' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

LimitExceededException:

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the IoT SiteWise User Guide.

BatchDisassociateProjectAssets

$result = $client->batchDisassociateProjectAssets([/* ... */]);
$promise = $client->batchDisassociateProjectAssetsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchDisassociateProjectAssets([
    'assetIds' => ['<string>', ...], // REQUIRED
    'clientToken' => '<string>',
    'projectId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'assetId' => '<string>',
            'code' => 'INTERNAL_FAILURE',
            'message' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

BatchGetAssetPropertyAggregates

$result = $client->batchGetAssetPropertyAggregates([/* ... */]);
$promise = $client->batchGetAssetPropertyAggregatesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchGetAssetPropertyAggregates([
    'entries' => [ // REQUIRED
        [
            'aggregateTypes' => ['<string>', ...], // REQUIRED
            'assetId' => '<string>',
            'endDate' => <integer || string || DateTime>, // REQUIRED
            'entryId' => '<string>', // REQUIRED
            'propertyAlias' => '<string>',
            'propertyId' => '<string>',
            'qualities' => ['<string>', ...],
            'resolution' => '<string>', // REQUIRED
            'startDate' => <integer || string || DateTime>, // REQUIRED
            'timeOrdering' => 'ASCENDING|DESCENDING',
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'errorEntries' => [
        [
            'entryId' => '<string>',
            'errorCode' => 'ResourceNotFoundException|InvalidRequestException|AccessDeniedException',
            'errorMessage' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'skippedEntries' => [
        [
            'completionStatus' => 'SUCCESS|ERROR',
            'entryId' => '<string>',
            'errorInfo' => [
                'errorCode' => 'ResourceNotFoundException|InvalidRequestException|AccessDeniedException',
                'errorTimestamp' => <DateTime>,
            ],
        ],
        // ...
    ],
    'successEntries' => [
        [
            'aggregatedValues' => [
                [
                    'quality' => 'GOOD|BAD|UNCERTAIN',
                    'timestamp' => <DateTime>,
                    'value' => [
                        'average' => <float>,
                        'count' => <float>,
                        'maximum' => <float>,
                        'minimum' => <float>,
                        'standardDeviation' => <float>,
                        'sum' => <float>,
                    ],
                ],
                // ...
            ],
            'entryId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

ServiceUnavailableException:

The requested service is unavailable.

BatchGetAssetPropertyValue

$result = $client->batchGetAssetPropertyValue([/* ... */]);
$promise = $client->batchGetAssetPropertyValueAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchGetAssetPropertyValue([
    'entries' => [ // REQUIRED
        [
            'assetId' => '<string>',
            'entryId' => '<string>', // REQUIRED
            'propertyAlias' => '<string>',
            'propertyId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'errorEntries' => [
        [
            'entryId' => '<string>',
            'errorCode' => 'ResourceNotFoundException|InvalidRequestException|AccessDeniedException',
            'errorMessage' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'skippedEntries' => [
        [
            'completionStatus' => 'SUCCESS|ERROR',
            'entryId' => '<string>',
            'errorInfo' => [
                'errorCode' => 'ResourceNotFoundException|InvalidRequestException|AccessDeniedException',
                'errorTimestamp' => <DateTime>,
            ],
        ],
        // ...
    ],
    'successEntries' => [
        [
            'assetPropertyValue' => [
                'quality' => 'GOOD|BAD|UNCERTAIN',
                'timestamp' => [
                    'offsetInNanos' => <integer>,
                    'timeInSeconds' => <integer>,
                ],
                'value' => [
                    'booleanValue' => true || false,
                    'doubleValue' => <float>,
                    'integerValue' => <integer>,
                    'nullValue' => [
                        'valueType' => 'D|B|S|I|U',
                    ],
                    'stringValue' => '<string>',
                ],
            ],
            'entryId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

ServiceUnavailableException:

The requested service is unavailable.

BatchGetAssetPropertyValueHistory

$result = $client->batchGetAssetPropertyValueHistory([/* ... */]);
$promise = $client->batchGetAssetPropertyValueHistoryAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchGetAssetPropertyValueHistory([
    'entries' => [ // REQUIRED
        [
            'assetId' => '<string>',
            'endDate' => <integer || string || DateTime>,
            'entryId' => '<string>', // REQUIRED
            'propertyAlias' => '<string>',
            'propertyId' => '<string>',
            'qualities' => ['<string>', ...],
            'startDate' => <integer || string || DateTime>,
            'timeOrdering' => 'ASCENDING|DESCENDING',
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'errorEntries' => [
        [
            'entryId' => '<string>',
            'errorCode' => 'ResourceNotFoundException|InvalidRequestException|AccessDeniedException',
            'errorMessage' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'skippedEntries' => [
        [
            'completionStatus' => 'SUCCESS|ERROR',
            'entryId' => '<string>',
            'errorInfo' => [
                'errorCode' => 'ResourceNotFoundException|InvalidRequestException|AccessDeniedException',
                'errorTimestamp' => <DateTime>,
            ],
        ],
        // ...
    ],
    'successEntries' => [
        [
            'assetPropertyValueHistory' => [
                [
                    'quality' => 'GOOD|BAD|UNCERTAIN',
                    'timestamp' => [
                        'offsetInNanos' => <integer>,
                        'timeInSeconds' => <integer>,
                    ],
                    'value' => [
                        'booleanValue' => true || false,
                        'doubleValue' => <float>,
                        'integerValue' => <integer>,
                        'nullValue' => [
                            'valueType' => 'D|B|S|I|U',
                        ],
                        'stringValue' => '<string>',
                    ],
                ],
                // ...
            ],
            'entryId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

ServiceUnavailableException:

The requested service is unavailable.

BatchPutAssetPropertyValue

$result = $client->batchPutAssetPropertyValue([/* ... */]);
$promise = $client->batchPutAssetPropertyValueAsync([/* ... */]);

Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the IoT SiteWise User Guide.

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

• The assetId and propertyId of an asset property.

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

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

Parameter Syntax

$result = $client->batchPutAssetPropertyValue([
    'enablePartialEntryProcessing' => true || false,
    '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>,
                        'nullValue' => [
                            'valueType' => 'D|B|S|I|U', // REQUIRED
                        ],
                        'stringValue' => '<string>',
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]);

Parameter Details

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

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

LimitExceededException:

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the IoT SiteWise User Guide.

ServiceUnavailableException:

The requested service is unavailable.

ConflictingOperationException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

CreateAccessPolicy

$result = $client->createAccessPolicy([/* ... */]);
$promise = $client->createAccessPolicyAsync([/* ... */]);

Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource.

Parameter Syntax

$result = $client->createAccessPolicy([
    'accessPolicyIdentity' => [ // REQUIRED
        'group' => [
            'id' => '<string>', // REQUIRED
        ],
        'iamRole' => [
            'arn' => '<string>', // REQUIRED
        ],
        'iamUser' => [
            'arn' => '<string>', // REQUIRED
        ],
        'user' => [
            'id' => '<string>', // REQUIRED
        ],
    ],
    'accessPolicyPermission' => 'ADMINISTRATOR|VIEWER', // REQUIRED
    'accessPolicyResource' => [ // REQUIRED
        'portal' => [
            'id' => '<string>', // REQUIRED
        ],
        'project' => [
            'id' => '<string>', // REQUIRED
        ],
    ],
    'clientToken' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'accessPolicyArn' => '<string>',
    'accessPolicyId' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

LimitExceededException:

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the IoT SiteWise User Guide.

CreateAsset

$result = $client->createAsset([/* ... */]);
$promise = $client->createAssetAsync([/* ... */]);

Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.

Parameter Syntax

$result = $client->createAsset([
    'assetDescription' => '<string>',
    'assetExternalId' => '<string>',
    'assetId' => '<string>',
    'assetModelId' => '<string>', // REQUIRED
    'assetName' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'assetArn' => '<string>',
    'assetId' => '<string>',
    'assetStatus' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            'details' => [
                [
                    'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message' => '<string>',
                ],
                // ...
            ],
            'message' => '<string>',
        ],
        'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED',
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceAlreadyExistsException:

The resource already exists.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

LimitExceededException:

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the IoT SiteWise User Guide.

ConflictingOperationException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

CreateAssetModel

$result = $client->createAssetModel([/* ... */]);
$promise = $client->createAssetModelAsync([/* ... */]);

Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.

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

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

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

Parameter Syntax

$result = $client->createAssetModel([
    'assetModelCompositeModels' => [
        [
            'description' => '<string>',
            'externalId' => '<string>',
            'id' => '<string>',
            'name' => '<string>', // REQUIRED
            'properties' => [
                [
                    'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', // REQUIRED
                    'dataTypeSpec' => '<string>',
                    'externalId' => '<string>',
                    'id' => '<string>',
                    'name' => '<string>', // REQUIRED
                    'type' => [ // REQUIRED
                        'attribute' => [
                            'defaultValue' => '<string>',
                        ],
                        'measurement' => [
                            'processingConfig' => [
                                'forwardingConfig' => [ // REQUIRED
                                    'state' => 'DISABLED|ENABLED', // REQUIRED
                                ],
                            ],
                        ],
                        'metric' => [
                            'expression' => '<string>', // REQUIRED
                            'processingConfig' => [
                                'computeLocation' => 'EDGE|CLOUD', // REQUIRED
                            ],
                            'variables' => [ // REQUIRED
                                [
                                    'name' => '<string>', // REQUIRED
                                    'value' => [ // REQUIRED
                                        'hierarchyId' => '<string>',
                                        'propertyId' => '<string>',
                                        'propertyPath' => [
                                            [
                                                'id' => '<string>',
                                                'name' => '<string>',
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                // ...
                            ],
                            'window' => [ // REQUIRED
                                'tumbling' => [
                                    'interval' => '<string>', // REQUIRED
                                    'offset' => '<string>',
                                ],
                            ],
                        ],
                        'transform' => [
                            'expression' => '<string>', // REQUIRED
                            'processingConfig' => [
                                'computeLocation' => 'EDGE|CLOUD', // REQUIRED
                                'forwardingConfig' => [
                                    'state' => 'DISABLED|ENABLED', // REQUIRED
                                ],
                            ],
                            'variables' => [ // REQUIRED
                                [
                                    'name' => '<string>', // REQUIRED
                                    'value' => [ // REQUIRED
                                        'hierarchyId' => '<string>',
                                        'propertyId' => '<string>',
                                        'propertyPath' => [
                                            [
                                                'id' => '<string>',
                                                'name' => '<string>',
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'unit' => '<string>',
                ],
                // ...
            ],
            'type' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'assetModelDescription' => '<string>',
    'assetModelExternalId' => '<string>',
    'assetModelHierarchies' => [
        [
            'childAssetModelId' => '<string>', // REQUIRED
            'externalId' => '<string>',
            'id' => '<string>',
            'name' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'assetModelId' => '<string>',
    'assetModelName' => '<string>', // REQUIRED
    'assetModelProperties' => [
        [
            'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', // REQUIRED
            'dataTypeSpec' => '<string>',
            'externalId' => '<string>',
            'id' => '<string>',
            'name' => '<string>', // REQUIRED
            'type' => [ // REQUIRED
                'attribute' => [
                    'defaultValue' => '<string>',
                ],
                'measurement' => [
                    'processingConfig' => [
                        'forwardingConfig' => [ // REQUIRED
                            'state' => 'DISABLED|ENABLED', // REQUIRED
                        ],
                    ],
                ],
                'metric' => [
                    'expression' => '<string>', // REQUIRED
                    'processingConfig' => [
                        'computeLocation' => 'EDGE|CLOUD', // REQUIRED
                    ],
                    'variables' => [ // REQUIRED
                        [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'hierarchyId' => '<string>',
                                'propertyId' => '<string>',
                                'propertyPath' => [
                                    [
                                        'id' => '<string>',
                                        'name' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'window' => [ // REQUIRED
                        'tumbling' => [
                            'interval' => '<string>', // REQUIRED
                            'offset' => '<string>',
                        ],
                    ],
                ],
                'transform' => [
                    'expression' => '<string>', // REQUIRED
                    'processingConfig' => [
                        'computeLocation' => 'EDGE|CLOUD', // REQUIRED
                        'forwardingConfig' => [
                            'state' => 'DISABLED|ENABLED', // REQUIRED
                        ],
                    ],
                    'variables' => [ // REQUIRED
                        [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'hierarchyId' => '<string>',
                                'propertyId' => '<string>',
                                'propertyPath' => [
                                    [
                                        'id' => '<string>',
                                        'name' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            'unit' => '<string>',
        ],
        // ...
    ],
    'assetModelType' => 'ASSET_MODEL|COMPONENT_MODEL',
    'clientToken' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'assetModelArn' => '<string>',
    'assetModelId' => '<string>',
    'assetModelStatus' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            'details' => [
                [
                    'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message' => '<string>',
                ],
                // ...
            ],
            'message' => '<string>',
        ],
        'state' => 'CREATING|ACTIVE|UPDATING|PROPAGATING|DELETING|FAILED',
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceAlreadyExistsException:

The resource already exists.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

LimitExceededException:

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the IoT SiteWise User Guide.

ConflictingOperationException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

CreateAssetModelCompositeModel

$result = $client->createAssetModelCompositeModel([/* ... */]);
$promise = $client->createAssetModelCompositeModelAsync([/* ... */]);

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

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

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

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

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

Parameter Syntax

$result = $client->createAssetModelCompositeModel([
    'assetModelCompositeModelDescription' => '<string>',
    'assetModelCompositeModelExternalId' => '<string>',
    'assetModelCompositeModelId' => '<string>',
    'assetModelCompositeModelName' => '<string>', // REQUIRED
    'assetModelCompositeModelProperties' => [
        [
            'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', // REQUIRED
            'dataTypeSpec' => '<string>',
            'externalId' => '<string>',
            'id' => '<string>',
            'name' => '<string>', // REQUIRED
            'type' => [ // REQUIRED
                'attribute' => [
                    'defaultValue' => '<string>',
                ],
                'measurement' => [
                    'processingConfig' => [
                        'forwardingConfig' => [ // REQUIRED
                            'state' => 'DISABLED|ENABLED', // REQUIRED
                        ],
                    ],
                ],
                'metric' => [
                    'expression' => '<string>', // REQUIRED
                    'processingConfig' => [
                        'computeLocation' => 'EDGE|CLOUD', // REQUIRED
                    ],
                    'variables' => [ // REQUIRED
                        [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'hierarchyId' => '<string>',
                                'propertyId' => '<string>',
                                'propertyPath' => [
                                    [
                                        'id' => '<string>',
                                        'name' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'window' => [ // REQUIRED
                        'tumbling' => [
                            'interval' => '<string>', // REQUIRED
                            'offset' => '<string>',
                        ],
                    ],
                ],
                'transform' => [
                    'expression' => '<string>', // REQUIRED
                    'processingConfig' => [
                        'computeLocation' => 'EDGE|CLOUD', // REQUIRED
                        'forwardingConfig' => [
                            'state' => 'DISABLED|ENABLED', // REQUIRED
                        ],
                    ],
                    'variables' => [ // REQUIRED
                        [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'hierarchyId' => '<string>',
                                'propertyId' => '<string>',
                                'propertyPath' => [
                                    [
                                        'id' => '<string>',
                                        'name' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            'unit' => '<string>',
        ],
        // ...
    ],
    'assetModelCompositeModelType' => '<string>', // REQUIRED
    'assetModelId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'composedAssetModelId' => '<string>',
    'ifMatch' => '<string>',
    'ifNoneMatch' => '<string>',
    'matchForVersionType' => 'LATEST|ACTIVE',
    'parentAssetModelCompositeModelId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'assetModelCompositeModelId' => '<string>',
    'assetModelCompositeModelPath' => [
        [
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'assetModelStatus' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            'details' => [
                [
                    'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message' => '<string>',
                ],
                // ...
            ],
            'message' => '<string>',
        ],
        'state' => 'CREATING|ACTIVE|UPDATING|PROPAGATING|DELETING|FAILED',
    ],
]

Result Details

Errors

ConflictingOperationException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

PreconditionFailedException:

The precondition in one or more of the request-header fields evaluated to FALSE.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceAlreadyExistsException:

The resource already exists.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

LimitExceededException:

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the IoT SiteWise User Guide.

CreateBulkImportJob

$result = $client->createBulkImportJob([/* ... */]);
$promise = $client->createBulkImportJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createBulkImportJob([
    'adaptiveIngestion' => true || false,
    'deleteFilesAfterImport' => true || false,
    'errorReportLocation' => [ // REQUIRED
        'bucket' => '<string>', // REQUIRED
        'prefix' => '<string>', // REQUIRED
    ],
    'files' => [ // REQUIRED
        [
            'bucket' => '<string>', // REQUIRED
            'key' => '<string>', // REQUIRED
            'versionId' => '<string>',
        ],
        // ...
    ],
    'jobConfiguration' => [ // REQUIRED
        'fileFormat' => [ // REQUIRED
            'csv' => [
                'columnNames' => ['<string>', ...], // REQUIRED
            ],
            'parquet' => [
            ],
        ],
    ],
    'jobName' => '<string>', // REQUIRED
    'jobRoleArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'jobId' => '<string>',
    'jobName' => '<string>',
    'jobStatus' => 'PENDING|CANCELLED|RUNNING|COMPLETED|FAILED|COMPLETED_WITH_FAILURES',
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceAlreadyExistsException:

The resource already exists.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

LimitExceededException:

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the IoT SiteWise User Guide.

ConflictingOperationException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

CreateDashboard

$result = $client->createDashboard([/* ... */]);
$promise = $client->createDashboardAsync([/* ... */]);

Creates a dashboard in an IoT SiteWise Monitor project.

Parameter Syntax

$result = $client->createDashboard([
    'clientToken' => '<string>',
    'dashboardDefinition' => '<string>', // REQUIRED
    'dashboardDescription' => '<string>',
    'dashboardName' => '<string>', // REQUIRED
    'projectId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'dashboardArn' => '<string>',
    'dashboardId' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

LimitExceededException:

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the IoT SiteWise User Guide.

CreateDataset

$result = $client->createDataset([/* ... */]);
$promise = $client->createDatasetAsync([/* ... */]);

Creates a dataset to connect an external datasource.

Parameter Syntax

$result = $client->createDataset([
    'clientToken' => '<string>',
    'datasetDescription' => '<string>',
    'datasetId' => '<string>',
    'datasetName' => '<string>', // REQUIRED
    'datasetSource' => [ // REQUIRED
        'sourceDetail' => [
            'kendra' => [
                'knowledgeBaseArn' => '<string>', // REQUIRED
                'roleArn' => '<string>', // REQUIRED
            ],
        ],
        'sourceFormat' => 'KNOWLEDGE_BASE', // REQUIRED
        'sourceType' => 'KENDRA', // REQUIRED
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'datasetArn' => '<string>',
    'datasetId' => '<string>',
    'datasetStatus' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            'details' => [
                [
                    'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message' => '<string>',
                ],
                // ...
            ],
            'message' => '<string>',
        ],
        'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED',
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceAlreadyExistsException:

The resource already exists.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

LimitExceededException:

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the IoT SiteWise User Guide.

ConflictingOperationException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

CreateGateway

$result = $client->createGateway([/* ... */]);
$promise = $client->createGatewayAsync([/* ... */]);

Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide.

Parameter Syntax

$result = $client->createGateway([
    'gatewayName' => '<string>', // REQUIRED
    'gatewayPlatform' => [ // REQUIRED
        'greengrass' => [
            'groupArn' => '<string>', // REQUIRED
        ],
        'greengrassV2' => [
            'coreDeviceOperatingSystem' => 'LINUX_AARCH64|LINUX_AMD64|WINDOWS_AMD64',
            'coreDeviceThingName' => '<string>', // REQUIRED
        ],
        'siemensIE' => [
            'iotCoreThingName' => '<string>', // REQUIRED
        ],
    ],
    'gatewayVersion' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'gatewayArn' => '<string>',
    'gatewayId' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceAlreadyExistsException:

The resource already exists.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

LimitExceededException:

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the IoT SiteWise User Guide.

CreatePortal

$result = $client->createPortal([/* ... */]);
$promise = $client->createPortalAsync([/* ... */]);

Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions.

Parameter Syntax

$result = $client->createPortal([
    'alarms' => [
        'alarmRoleArn' => '<string>', // REQUIRED
        'notificationLambdaArn' => '<string>',
    ],
    'clientToken' => '<string>',
    'notificationSenderEmail' => '<string>',
    'portalAuthMode' => 'IAM|SSO',
    'portalContactEmail' => '<string>', // REQUIRED
    'portalDescription' => '<string>',
    'portalLogoImageFile' => [
        'data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
        'type' => 'PNG', // REQUIRED
    ],
    'portalName' => '<string>', // REQUIRED
    'portalType' => 'SITEWISE_PORTAL_V1|SITEWISE_PORTAL_V2',
    'portalTypeConfiguration' => [
        '<PortalTypeKey>' => [
            'portalTools' => ['<string>', ...],
        ],
        // ...
    ],
    'roleArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'portalArn' => '<string>',
    'portalId' => '<string>',
    'portalStartUrl' => '<string>',
    'portalStatus' => [
        'error' => [
            'code' => 'INTERNAL_FAILURE|VALIDATION_ERROR|LIMIT_EXCEEDED',
            'message' => '<string>',
        ],
        'state' => 'CREATING|PENDING|UPDATING|DELETING|ACTIVE|FAILED',
    ],
    'ssoApplicationId' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

LimitExceededException:

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the IoT SiteWise User Guide.

CreateProject

$result = $client->createProject([/* ... */]);
$promise = $client->createProjectAsync([/* ... */]);

Creates a project in the specified portal.

Parameter Syntax

$result = $client->createProject([
    'clientToken' => '<string>',
    'portalId' => '<string>', // REQUIRED
    'projectDescription' => '<string>',
    'projectName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'projectArn' => '<string>',
    'projectId' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

LimitExceededException:

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the IoT SiteWise User Guide.

DeleteAccessPolicy

$result = $client->deleteAccessPolicy([/* ... */]);
$promise = $client->deleteAccessPolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteAccessPolicy([
    'accessPolicyId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DeleteAsset

$result = $client->deleteAsset([/* ... */]);
$promise = $client->deleteAssetAsync([/* ... */]);

Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

Parameter Syntax

$result = $client->deleteAsset([
    'assetId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'assetStatus' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            'details' => [
                [
                    'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message' => '<string>',
                ],
                // ...
            ],
            'message' => '<string>',
        ],
        'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED',
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

ConflictingOperationException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

DeleteAssetModel

$result = $client->deleteAssetModel([/* ... */]);
$promise = $client->deleteAssetModelAsync([/* ... */]);

Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

Parameter Syntax

$result = $client->deleteAssetModel([
    'assetModelId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'ifMatch' => '<string>',
    'ifNoneMatch' => '<string>',
    'matchForVersionType' => 'LATEST|ACTIVE',
]);

Parameter Details

Result Syntax

[
    'assetModelStatus' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            'details' => [
                [
                    'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message' => '<string>',
                ],
                // ...
            ],
            'message' => '<string>',
        ],
        'state' => 'CREATING|ACTIVE|UPDATING|PROPAGATING|DELETING|FAILED',
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

ConflictingOperationException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

PreconditionFailedException:

The precondition in one or more of the request-header fields evaluated to FALSE.

DeleteAssetModelCompositeModel

$result = $client->deleteAssetModelCompositeModel([/* ... */]);
$promise = $client->deleteAssetModelCompositeModelAsync([/* ... */]);

Deletes a composite model. This action can't be undone. You must delete all assets created from a composite model before you can delete the model. Also, you can't delete a composite model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

Parameter Syntax

$result = $client->deleteAssetModelCompositeModel([
    'assetModelCompositeModelId' => '<string>', // REQUIRED
    'assetModelId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'ifMatch' => '<string>',
    'ifNoneMatch' => '<string>',
    'matchForVersionType' => 'LATEST|ACTIVE',
]);

Parameter Details

Result Syntax

[
    'assetModelStatus' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            'details' => [
                [
                    'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message' => '<string>',
                ],
                // ...
            ],
            'message' => '<string>',
        ],
        'state' => 'CREATING|ACTIVE|UPDATING|PROPAGATING|DELETING|FAILED',
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

ConflictingOperationException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

PreconditionFailedException:

The precondition in one or more of the request-header fields evaluated to FALSE.

DeleteDashboard

$result = $client->deleteDashboard([/* ... */]);
$promise = $client->deleteDashboardAsync([/* ... */]);

Deletes a dashboard from IoT SiteWise Monitor.

Parameter Syntax

$result = $client->deleteDashboard([
    'clientToken' => '<string>',
    'dashboardId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DeleteDataset

$result = $client->deleteDataset([/* ... */]);
$promise = $client->deleteDatasetAsync([/* ... */]);

Deletes a dataset. This cannot be undone.

Parameter Syntax

$result = $client->deleteDataset([
    'clientToken' => '<string>',
    'datasetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'datasetStatus' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            'details' => [
                [
                    'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message' => '<string>',
                ],
                // ...
            ],
            'message' => '<string>',
        ],
        'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED',
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

ConflictingOperationException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

DeleteGateway

$result = $client->deleteGateway([/* ... */]);
$promise = $client->deleteGatewayAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteGateway([
    'gatewayId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

ConflictingOperationException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DeletePortal

$result = $client->deletePortal([/* ... */]);
$promise = $client->deletePortalAsync([/* ... */]);

Deletes a portal from IoT SiteWise Monitor.

Parameter Syntax

$result = $client->deletePortal([
    'clientToken' => '<string>',
    'portalId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'portalStatus' => [
        'error' => [
            'code' => 'INTERNAL_FAILURE|VALIDATION_ERROR|LIMIT_EXCEEDED',
            'message' => '<string>',
        ],
        'state' => 'CREATING|PENDING|UPDATING|DELETING|ACTIVE|FAILED',
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

ConflictingOperationException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

DeleteProject

$result = $client->deleteProject([/* ... */]);
$promise = $client->deleteProjectAsync([/* ... */]);

Deletes a project from IoT SiteWise Monitor.

Parameter Syntax

$result = $client->deleteProject([
    'clientToken' => '<string>',
    'projectId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DeleteTimeSeries

$result = $client->deleteTimeSeries([/* ... */]);
$promise = $client->deleteTimeSeriesAsync([/* ... */]);

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

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

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

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

  • The alias of the time series.

  • The assetId and propertyId that identifies the asset property.

Parameter Syntax

$result = $client->deleteTimeSeries([
    'alias' => '<string>',
    'assetId' => '<string>',
    'clientToken' => '<string>',
    'propertyId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

ConflictingOperationException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

DescribeAccessPolicy

$result = $client->describeAccessPolicy([/* ... */]);
$promise = $client->describeAccessPolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeAccessPolicy([
    'accessPolicyId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'accessPolicyArn' => '<string>',
    'accessPolicyCreationDate' => <DateTime>,
    'accessPolicyId' => '<string>',
    'accessPolicyIdentity' => [
        'group' => [
            'id' => '<string>',
        ],
        'iamRole' => [
            'arn' => '<string>',
        ],
        'iamUser' => [
            'arn' => '<string>',
        ],
        'user' => [
            'id' => '<string>',
        ],
    ],
    'accessPolicyLastUpdateDate' => <DateTime>,
    'accessPolicyPermission' => 'ADMINISTRATOR|VIEWER',
    'accessPolicyResource' => [
        'portal' => [
            'id' => '<string>',
        ],
        'project' => [
            'id' => '<string>',
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DescribeAction

$result = $client->describeAction([/* ... */]);
$promise = $client->describeActionAsync([/* ... */]);

Retrieves information about an action.

Parameter Syntax

$result = $client->describeAction([
    'actionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'actionDefinitionId' => '<string>',
    'actionId' => '<string>',
    'actionPayload' => [
        'stringValue' => '<string>',
    ],
    'executionTime' => <DateTime>,
    'targetResource' => [
        'assetId' => '<string>',
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DescribeAsset

$result = $client->describeAsset([/* ... */]);
$promise = $client->describeAssetAsync([/* ... */]);

Retrieves information about an asset.

Parameter Syntax

$result = $client->describeAsset([
    'assetId' => '<string>', // REQUIRED
    'excludeProperties' => true || false,
]);

Parameter Details

Result Syntax

[
    'assetArn' => '<string>',
    'assetCompositeModelSummaries' => [
        [
            'description' => '<string>',
            'externalId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'path' => [
                [
                    'id' => '<string>',
                    'name' => '<string>',
                ],
                // ...
            ],
            'type' => '<string>',
        ],
        // ...
    ],
    'assetCompositeModels' => [
        [
            'description' => '<string>',
            'externalId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'properties' => [
                [
                    'alias' => '<string>',
                    'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT',
                    'dataTypeSpec' => '<string>',
                    'externalId' => '<string>',
                    'id' => '<string>',
                    'name' => '<string>',
                    'notification' => [
                        'state' => 'ENABLED|DISABLED',
                        'topic' => '<string>',
                    ],
                    'path' => [
                        [
                            'id' => '<string>',
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                    'unit' => '<string>',
                ],
                // ...
            ],
            'type' => '<string>',
        ],
        // ...
    ],
    'assetCreationDate' => <DateTime>,
    'assetDescription' => '<string>',
    'assetExternalId' => '<string>',
    'assetHierarchies' => [
        [
            'externalId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'assetId' => '<string>',
    'assetLastUpdateDate' => <DateTime>,
    'assetModelId' => '<string>',
    'assetName' => '<string>',
    'assetProperties' => [
        [
            'alias' => '<string>',
            'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT',
            'dataTypeSpec' => '<string>',
            'externalId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'notification' => [
                'state' => 'ENABLED|DISABLED',
                'topic' => '<string>',
            ],
            'path' => [
                [
                    'id' => '<string>',
                    'name' => '<string>',
                ],
                // ...
            ],
            'unit' => '<string>',
        ],
        // ...
    ],
    'assetStatus' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            'details' => [
                [
                    'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message' => '<string>',
                ],
                // ...
            ],
            'message' => '<string>',
        ],
        'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED',
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DescribeAssetCompositeModel

$result = $client->describeAssetCompositeModel([/* ... */]);
$promise = $client->describeAssetCompositeModelAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeAssetCompositeModel([
    'assetCompositeModelId' => '<string>', // REQUIRED
    'assetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'actionDefinitions' => [
        [
            'actionDefinitionId' => '<string>',
            'actionName' => '<string>',
            'actionType' => '<string>',
        ],
        // ...
    ],
    'assetCompositeModelDescription' => '<string>',
    'assetCompositeModelExternalId' => '<string>',
    'assetCompositeModelId' => '<string>',
    'assetCompositeModelName' => '<string>',
    'assetCompositeModelPath' => [
        [
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'assetCompositeModelProperties' => [
        [
            'alias' => '<string>',
            'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT',
            'dataTypeSpec' => '<string>',
            'externalId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'notification' => [
                'state' => 'ENABLED|DISABLED',
                'topic' => '<string>',
            ],
            'path' => [
                [
                    'id' => '<string>',
                    'name' => '<string>',
                ],
                // ...
            ],
            'unit' => '<string>',
        ],
        // ...
    ],
    'assetCompositeModelSummaries' => [
        [
            'description' => '<string>',
            'externalId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'path' => [
                [
                    'id' => '<string>',
                    'name' => '<string>',
                ],
                // ...
            ],
            'type' => '<string>',
        ],
        // ...
    ],
    'assetCompositeModelType' => '<string>',
    'assetId' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DescribeAssetModel

$result = $client->describeAssetModel([/* ... */]);
$promise = $client->describeAssetModelAsync([/* ... */]);

Retrieves information about an asset model.

Parameter Syntax

$result = $client->describeAssetModel([
    'assetModelId' => '<string>', // REQUIRED
    'assetModelVersion' => '<string>',
    'excludeProperties' => true || false,
]);

Parameter Details

Result Syntax

[
    'assetModelArn' => '<string>',
    'assetModelCompositeModelSummaries' => [
        [
            'description' => '<string>',
            'externalId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'path' => [
                [
                    'id' => '<string>',
                    'name' => '<string>',
                ],
                // ...
            ],
            'type' => '<string>',
        ],
        // ...
    ],
    'assetModelCompositeModels' => [
        [
            'description' => '<string>',
            'externalId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'properties' => [
                [
                    'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT',
                    'dataTypeSpec' => '<string>',
                    'externalId' => '<string>',
                    'id' => '<string>',
                    'name' => '<string>',
                    'path' => [
                        [
                            'id' => '<string>',
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                    'type' => [
                        'attribute' => [
                            'defaultValue' => '<string>',
                        ],
                        'measurement' => [
                            'processingConfig' => [
                                'forwardingConfig' => [
                                    'state' => 'DISABLED|ENABLED',
                                ],
                            ],
                        ],
                        'metric' => [
                            'expression' => '<string>',
                            'processingConfig' => [
                                'computeLocation' => 'EDGE|CLOUD',
                            ],
                            'variables' => [
                                [
                                    'name' => '<string>',
                                    'value' => [
                                        'hierarchyId' => '<string>',
                                        'propertyId' => '<string>',
                                        'propertyPath' => [
                                            [
                                                'id' => '<string>',
                                                'name' => '<string>',
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                // ...
                            ],
                            'window' => [
                                'tumbling' => [
                                    'interval' => '<string>',
                                    'offset' => '<string>',
                                ],
                            ],
                        ],
                        'transform' => [
                            'expression' => '<string>',
                            'processingConfig' => [
                                'computeLocation' => 'EDGE|CLOUD',
                                'forwardingConfig' => [
                                    'state' => 'DISABLED|ENABLED',
                                ],
                            ],
                            'variables' => [
                                [
                                    'name' => '<string>',
                                    'value' => [
                                        'hierarchyId' => '<string>',
                                        'propertyId' => '<string>',
                                        'propertyPath' => [
                                            [
                                                'id' => '<string>',
                                                'name' => '<string>',
                                            ],
                                            // ...
                                        ],
                                    ],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'unit' => '<string>',
                ],
                // ...
            ],
            'type' => '<string>',
        ],
        // ...
    ],
    'assetModelCreationDate' => <DateTime>,
    'assetModelDescription' => '<string>',
    'assetModelExternalId' => '<string>',
    'assetModelHierarchies' => [
        [
            'childAssetModelId' => '<string>',
            'externalId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'assetModelId' => '<string>',
    'assetModelLastUpdateDate' => <DateTime>,
    'assetModelName' => '<string>',
    'assetModelProperties' => [
        [
            'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT',
            'dataTypeSpec' => '<string>',
            'externalId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'path' => [
                [
                    'id' => '<string>',
                    'name' => '<string>',
                ],
                // ...
            ],
            'type' => [
                'attribute' => [
                    'defaultValue' => '<string>',
                ],
                'measurement' => [
                    'processingConfig' => [
                        'forwardingConfig' => [
                            'state' => 'DISABLED|ENABLED',
                        ],
                    ],
                ],
                'metric' => [
                    'expression' => '<string>',
                    'processingConfig' => [
                        'computeLocation' => 'EDGE|CLOUD',
                    ],
                    'variables' => [
                        [
                            'name' => '<string>',
                            'value' => [
                                'hierarchyId' => '<string>',
                                'propertyId' => '<string>',
                                'propertyPath' => [
                                    [
                                        'id' => '<string>',
                                        'name' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'window' => [
                        'tumbling' => [
                            'interval' => '<string>',
                            'offset' => '<string>',
                        ],
                    ],
                ],
                'transform' => [
                    'expression' => '<string>',
                    'processingConfig' => [
                        'computeLocation' => 'EDGE|CLOUD',
                        'forwardingConfig' => [
                            'state' => 'DISABLED|ENABLED',
                        ],
                    ],
                    'variables' => [
                        [
                            'name' => '<string>',
                            'value' => [
                                'hierarchyId' => '<string>',
                                'propertyId' => '<string>',
                                'propertyPath' => [
                                    [
                                        'id' => '<string>',
                                        'name' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            'unit' => '<string>',
        ],
        // ...
    ],
    'assetModelStatus' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            'details' => [
                [
                    'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message' => '<string>',
                ],
                // ...
            ],
            'message' => '<string>',
        ],
        'state' => 'CREATING|ACTIVE|UPDATING|PROPAGATING|DELETING|FAILED',
    ],
    'assetModelType' => 'ASSET_MODEL|COMPONENT_MODEL',
    'assetModelVersion' => '<string>',
    'eTag' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DescribeAssetModelCompositeModel

$result = $client->describeAssetModelCompositeModel([/* ... */]);
$promise = $client->describeAssetModelCompositeModelAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeAssetModelCompositeModel([
    'assetModelCompositeModelId' => '<string>', // REQUIRED
    'assetModelId' => '<string>', // REQUIRED
    'assetModelVersion' => '<string>',
]);

Parameter Details

Result Syntax

[
    'actionDefinitions' => [
        [
            'actionDefinitionId' => '<string>',
            'actionName' => '<string>',
            'actionType' => '<string>',
        ],
        // ...
    ],
    'assetModelCompositeModelDescription' => '<string>',
    'assetModelCompositeModelExternalId' => '<string>',
    'assetModelCompositeModelId' => '<string>',
    'assetModelCompositeModelName' => '<string>',
    'assetModelCompositeModelPath' => [
        [
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'assetModelCompositeModelProperties' => [
        [
            'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT',
            'dataTypeSpec' => '<string>',
            'externalId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'path' => [
                [
                    'id' => '<string>',
                    'name' => '<string>',
                ],
                // ...
            ],
            'type' => [
                'attribute' => [
                    'defaultValue' => '<string>',
                ],
                'measurement' => [
                    'processingConfig' => [
                        'forwardingConfig' => [
                            'state' => 'DISABLED|ENABLED',
                        ],
                    ],
                ],
                'metric' => [
                    'expression' => '<string>',
                    'processingConfig' => [
                        'computeLocation' => 'EDGE|CLOUD',
                    ],
                    'variables' => [
                        [
                            'name' => '<string>',
                            'value' => [
                                'hierarchyId' => '<string>',
                                'propertyId' => '<string>',
                                'propertyPath' => [
                                    [
                                        'id' => '<string>',
                                        'name' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'window' => [
                        'tumbling' => [
                            'interval' => '<string>',
                            'offset' => '<string>',
                        ],
                    ],
                ],
                'transform' => [
                    'expression' => '<string>',
                    'processingConfig' => [
                        'computeLocation' => 'EDGE|CLOUD',
                        'forwardingConfig' => [
                            'state' => 'DISABLED|ENABLED',
                        ],
                    ],
                    'variables' => [
                        [
                            'name' => '<string>',
                            'value' => [
                                'hierarchyId' => '<string>',
                                'propertyId' => '<string>',
                                'propertyPath' => [
                                    [
                                        'id' => '<string>',
                                        'name' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            'unit' => '<string>',
        ],
        // ...
    ],
    'assetModelCompositeModelSummaries' => [
        [
            'description' => '<string>',
            'externalId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'path' => [
                [
                    'id' => '<string>',
                    'name' => '<string>',
                ],
                // ...
            ],
            'type' => '<string>',
        ],
        // ...
    ],
    'assetModelCompositeModelType' => '<string>',
    'assetModelId' => '<string>',
    'compositionDetails' => [
        'compositionRelationship' => [
            [
                'id' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DescribeAssetProperty

$result = $client->describeAssetProperty([/* ... */]);
$promise = $client->describeAssetPropertyAsync([/* ... */]);

Retrieves information about an asset property.

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

Result Syntax

[
    'assetExternalId' => '<string>',
    'assetId' => '<string>',
    'assetModelId' => '<string>',
    'assetName' => '<string>',
    'assetProperty' => [
        'alias' => '<string>',
        'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT',
        'externalId' => '<string>',
        'id' => '<string>',
        'name' => '<string>',
        'notification' => [
            'state' => 'ENABLED|DISABLED',
            'topic' => '<string>',
        ],
        'path' => [
            [
                'id' => '<string>',
                'name' => '<string>',
            ],
            // ...
        ],
        'type' => [
            'attribute' => [
                'defaultValue' => '<string>',
            ],
            'measurement' => [
                'processingConfig' => [
                    'forwardingConfig' => [
                        'state' => 'DISABLED|ENABLED',
                    ],
                ],
            ],
            'metric' => [
                'expression' => '<string>',
                'processingConfig' => [
                    'computeLocation' => 'EDGE|CLOUD',
                ],
                'variables' => [
                    [
                        'name' => '<string>',
                        'value' => [
                            'hierarchyId' => '<string>',
                            'propertyId' => '<string>',
                            'propertyPath' => [
                                [
                                    'id' => '<string>',
                                    'name' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    // ...
                ],
                'window' => [
                    'tumbling' => [
                        'interval' => '<string>',
                        'offset' => '<string>',
                    ],
                ],
            ],
            'transform' => [
                'expression' => '<string>',
                'processingConfig' => [
                    'computeLocation' => 'EDGE|CLOUD',
                    'forwardingConfig' => [
                        'state' => 'DISABLED|ENABLED',
                    ],
                ],
                'variables' => [
                    [
                        'name' => '<string>',
                        'value' => [
                            'hierarchyId' => '<string>',
                            'propertyId' => '<string>',
                            'propertyPath' => [
                                [
                                    'id' => '<string>',
                                    'name' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'unit' => '<string>',
    ],
    'compositeModel' => [
        'assetProperty' => [
            'alias' => '<string>',
            'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT',
            'externalId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'notification' => [
                'state' => 'ENABLED|DISABLED',
                'topic' => '<string>',
            ],
            'path' => [
                [
                    'id' => '<string>',
                    'name' => '<string>',
                ],
                // ...
            ],
            'type' => [
                'attribute' => [
                    'defaultValue' => '<string>',
                ],
                'measurement' => [
                    'processingConfig' => [
                        'forwardingConfig' => [
                            'state' => 'DISABLED|ENABLED',
                        ],
                    ],
                ],
                'metric' => [
                    'expression' => '<string>',
                    'processingConfig' => [
                        'computeLocation' => 'EDGE|CLOUD',
                    ],
                    'variables' => [
                        [
                            'name' => '<string>',
                            'value' => [
                                'hierarchyId' => '<string>',
                                'propertyId' => '<string>',
                                'propertyPath' => [
                                    [
                                        'id' => '<string>',
                                        'name' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                    'window' => [
                        'tumbling' => [
                            'interval' => '<string>',
                            'offset' => '<string>',
                        ],
                    ],
                ],
                'transform' => [
                    'expression' => '<string>',
                    'processingConfig' => [
                        'computeLocation' => 'EDGE|CLOUD',
                        'forwardingConfig' => [
                            'state' => 'DISABLED|ENABLED',
                        ],
                    ],
                    'variables' => [
                        [
                            'name' => '<string>',
                            'value' => [
                                'hierarchyId' => '<string>',
                                'propertyId' => '<string>',
                                'propertyPath' => [
                                    [
                                        'id' => '<string>',
                                        'name' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            'unit' => '<string>',
        ],
        'externalId' => '<string>',
        'id' => '<string>',
        'name' => '<string>',
        'type' => '<string>',
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DescribeBulkImportJob

$result = $client->describeBulkImportJob([/* ... */]);
$promise = $client->describeBulkImportJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeBulkImportJob([
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'adaptiveIngestion' => true || false,
    'deleteFilesAfterImport' => true || false,
    'errorReportLocation' => [
        'bucket' => '<string>',
        'prefix' => '<string>',
    ],
    'files' => [
        [
            'bucket' => '<string>',
            'key' => '<string>',
            'versionId' => '<string>',
        ],
        // ...
    ],
    'jobConfiguration' => [
        'fileFormat' => [
            'csv' => [
                'columnNames' => ['<string>', ...],
            ],
            'parquet' => [
            ],
        ],
    ],
    'jobCreationDate' => <DateTime>,
    'jobId' => '<string>',
    'jobLastUpdateDate' => <DateTime>,
    'jobName' => '<string>',
    'jobRoleArn' => '<string>',
    'jobStatus' => 'PENDING|CANCELLED|RUNNING|COMPLETED|FAILED|COMPLETED_WITH_FAILURES',
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DescribeDashboard

$result = $client->describeDashboard([/* ... */]);
$promise = $client->describeDashboardAsync([/* ... */]);

Retrieves information about a dashboard.

Parameter Syntax

$result = $client->describeDashboard([
    'dashboardId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'dashboardArn' => '<string>',
    'dashboardCreationDate' => <DateTime>,
    'dashboardDefinition' => '<string>',
    'dashboardDescription' => '<string>',
    'dashboardId' => '<string>',
    'dashboardLastUpdateDate' => <DateTime>,
    'dashboardName' => '<string>',
    'projectId' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DescribeDataset

$result = $client->describeDataset([/* ... */]);
$promise = $client->describeDatasetAsync([/* ... */]);

Retrieves information about a dataset.

Parameter Syntax

$result = $client->describeDataset([
    'datasetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'datasetArn' => '<string>',
    'datasetCreationDate' => <DateTime>,
    'datasetDescription' => '<string>',
    'datasetId' => '<string>',
    'datasetLastUpdateDate' => <DateTime>,
    'datasetName' => '<string>',
    'datasetSource' => [
        'sourceDetail' => [
            'kendra' => [
                'knowledgeBaseArn' => '<string>',
                'roleArn' => '<string>',
            ],
        ],
        'sourceFormat' => 'KNOWLEDGE_BASE',
        'sourceType' => 'KENDRA',
    ],
    'datasetStatus' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            'details' => [
                [
                    'code' => 'INCOMPATIBLE_COMPUTE_LOCATION|INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message' => '<string>',
                ],
                // ...
            ],
            'message' => '<string>',
        ],
        'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED',
    ],
    'datasetVersion' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DescribeDefaultEncryptionConfiguration

$result = $client->describeDefaultEncryptionConfiguration([/* ... */]);
$promise = $client->describeDefaultEncryptionConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeDefaultEncryptionConfiguration([
]);

Parameter Details

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

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DescribeGateway

$result = $client->describeGateway([/* ... */]);
$promise = $client->describeGatewayAsync([/* ... */]);

Retrieves information about a gateway.

Parameter Syntax

$result = $client->describeGateway([
    'gatewayId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'creationDate' => <DateTime>,
    'gatewayArn' => '<string>',
    'gatewayCapabilitySummaries' => [
        [
            'capabilityNamespace' => '<string>',
            'capabilitySyncStatus' => 'IN_SYNC|OUT_OF_SYNC|SYNC_FAILED|UNKNOWN|NOT_APPLICABLE',
        ],
        // ...
    ],
    'gatewayId' => '<string>',
    'gatewayName' => '<string>',
    'gatewayPlatform' => [
        'greengrass' => [
            'groupArn' => '<string>',
        ],
        'greengrassV2' => [
            'coreDeviceOperatingSystem' => 'LINUX_AARCH64|LINUX_AMD64|WINDOWS_AMD64',
            'coreDeviceThingName' => '<string>',
        ],
        'siemensIE' => [
            'iotCoreThingName' => '<string>',
        ],
    ],
    'gatewayVersion' => '<string>',
    'lastUpdateDate' => <DateTime>,
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DescribeGatewayCapabilityConfiguration

$result = $client->describeGatewayCapabilityConfiguration([/* ... */]);
$promise = $client->describeGatewayCapabilityConfigurationAsync([/* ... */]);

Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.

Parameter Syntax

$result = $client->describeGatewayCapabilityConfiguration([
    'capabilityNamespace' => '<string>', // REQUIRED
    'gatewayId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'capabilityConfiguration' => '<string>',
    'capabilityNamespace' => '<string>',
    'capabilitySyncStatus' => 'IN_SYNC|OUT_OF_SYNC|SYNC_FAILED|UNKNOWN|NOT_APPLICABLE',
    'gatewayId' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DescribeLoggingOptions

$result = $client->describeLoggingOptions([/* ... */]);
$promise = $client->describeLoggingOptionsAsync([/* ... */]);

Retrieves the current IoT SiteWise logging options.

Parameter Syntax

$result = $client->describeLoggingOptions([
]);

Parameter Details

Result Syntax

[
    'loggingOptions' => [
        'level' => 'ERROR|INFO|OFF',
    ],
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ResourceNotFoundException:

The requested resource can't be found.

DescribePortal

$result = $client->describePortal([/* ... */]);
$promise = $client->describePortalAsync([/* ... */]);

Retrieves information about a portal.

Parameter Syntax

$result = $client->describePortal([
    'portalId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'alarms' => [
        'alarmRoleArn' => '<string>',
        'notificationLambdaArn' => '<string>',
    ],
    'notificationSenderEmail' => '<string>',
    'portalArn' => '<string>',
    'portalAuthMode' => 'IAM|SSO',
    'portalClientId' => '<string>',
    'portalContactEmail' => '<string>',
    'portalCreationDate' => <DateTime>,
    'portalDescription' => '<string>',
    'portalId' => '<string>',
    'portalLastUpdateDate' => <DateTime>,
    'portalLogoImageLocation' => [
        'id' => '<string>',
        'url' => '<string>',
    ],
    'portalName' => '<string>',
    'portalStartUrl' => '<string>',
    'portalStatus' => [
        'error' => [
            'code' => 'INTERNAL_FAILURE|VALIDATION_ERROR|LIMIT_EXCEEDED',
            'message' => '<string>',
        ],
        'state' => 'CREATING|PENDING|UPDATING|DELETING|ACTIVE|FAILED',
    ],
    'portalType' => 'SITEWISE_PORTAL_V1|SITEWISE_PORTAL_V2',
    'portalTypeConfiguration' => [
        '<PortalTypeKey>' => [
            'portalTools' => ['<string>', ...],
        ],
        // ...
    ],
    'roleArn' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DescribeProject

$result = $client->describeProject([/* ... */]);
$promise = $client->describeProjectAsync([/* ... */]);

Retrieves information about a project.

Parameter Syntax

$result = $client->describeProject([
    'projectId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'portalId' => '<string>',
    'projectArn' => '<string>',
    'projectCreationDate' => <DateTime>,
    'projectDescription' => '<string>',
    'projectId' => '<string>',
    'projectLastUpdateDate' => <DateTime>,
    'projectName' => '<string>',
]

Result Details

Errors

InvalidRequestException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

ResourceNotFoundException:

The requested resource can't be found.

InternalFailureException:

IoT SiteWise can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.

DescribeStorageConfiguration

$result = $client->describeStorageConfiguration([/* ... */]);
$promise = $client->describeStorageConfigurationAsync([/* ... */]);

Retrieves information about the storage configuration for IoT SiteWise.

Parameter Syntax

$result = $client->describeStorageConfiguration([
]);

Parameter Details

Result Syntax

[
    'configurationStatus' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            'message' => '<string>',
        ],
        'state' => 'ACTIVE|UPDATE_IN_PROGRESS|UPDATE_FAILED',
    ],
    'disallowIngestNullNaN' => true || false,
    'disassociatedDataStorage' => 'ENABLED|DISABLED',
    'lastUpdateDate' => <DateTime>,
    'multiLayerStorage' => [
        'customerManagedS3Storage' => [
            'roleArn' => '<string>',
            's3ResourceArn' => '<string>',
        ],
    ],
    'retentionPeriod' => [
        'numberOfDays' => <integer>,
        'unlimited' => true || false,
    ],
    'storageType' => 'SITEWISE_DEFAULT_STORAGE|MULTI_LAYER_STORAGE',
    'warmTier' => 'ENABLED|DISABLED',
    'warmTierRetentionPeriod' => [
        'numberOfDays' => <integer>,
        'unlimited' => true || false,
    ],
]

Result Details