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

BatchAssociateDataSegmentsToDataset

$result = $client->batchAssociateDataSegmentsToDataset([/* ... */]);
$promise = $client->batchAssociateDataSegmentsToDatasetAsync([/* ... */]);

Associates a batch of data segments with a curated dataset. Data segments are time-bounded slices of time series data selected from source session datasets. Data segments that belong to the same time series can't overlap in time, regardless of which dataset they belong to.

Parameter Syntax

$result = $client->batchAssociateDataSegmentsToDataset([
    'associateDataSegmentEntries' => [ // REQUIRED
        [
            'endTimestamp' => [ // REQUIRED
                'offsetInNanos' => <integer>,
                'timeInSeconds' => <integer>, // REQUIRED
            ],
            'sourceDatasetId' => '<string>', // REQUIRED
            'startTimestamp' => [ // REQUIRED
                'offsetInNanos' => <integer>,
                'timeInSeconds' => <integer>, // REQUIRED
            ],
            'timeSeriesId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'clientToken' => '<string>',
    'datasetId' => '<string>', // REQUIRED
    'workspaceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'datasetId' => '<string>',
    'datasetVersion' => '<string>',
    'failedAssociations' => [
        [
            'endTimestamp' => [
                'offsetInNanos' => <integer>,
                'timeInSeconds' => <integer>,
            ],
            'errorCode' => 'INTERNAL_FAILURE|VALIDATION_ERROR|RESOURCE_NOT_FOUND|LIMIT_EXCEEDED|CONFLICTING_OPERATION',
            'errorMessage' => '<string>',
            'sourceDatasetId' => '<string>',
            'startTimestamp' => [
                'offsetInNanos' => <integer>,
                'timeInSeconds' => <integer>,
            ],
            'timeSeriesId' => '<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 quota 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.

BatchAssociateProjectAssets

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

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

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

BatchDeleteDatasetDataSegments

$result = $client->batchDeleteDatasetDataSegments([/* ... */]);
$promise = $client->batchDeleteDatasetDataSegmentsAsync([/* ... */]);

Deletes a batch of data segments from a session dataset. Deleting a data segment deletes the underlying time series data for the segment's time range.

Parameter Syntax

$result = $client->batchDeleteDatasetDataSegments([
    'clientToken' => '<string>',
    'datasetId' => '<string>', // REQUIRED
    'deleteDataSegmentEntries' => [ // REQUIRED
        [
            'endTimestamp' => [ // REQUIRED
                'offsetInNanos' => <integer>,
                'timeInSeconds' => <integer>, // REQUIRED
            ],
            'startTimestamp' => [ // REQUIRED
                'offsetInNanos' => <integer>,
                'timeInSeconds' => <integer>, // REQUIRED
            ],
            'timeSeriesId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'workspaceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'datasetId' => '<string>',
    'datasetVersion' => '<string>',
    'errors' => [
        [
            'endTimestamp' => [
                'offsetInNanos' => <integer>,
                'timeInSeconds' => <integer>,
            ],
            'errorCode' => 'INTERNAL_FAILURE|VALIDATION_ERROR|RESOURCE_NOT_FOUND|LIMIT_EXCEEDED|CONFLICTING_OPERATION',
            'errorMessage' => '<string>',
            'startTimestamp' => [
                'offsetInNanos' => <integer>,
                'timeInSeconds' => <integer>,
            ],
            'timeSeriesId' => '<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.

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.

BatchDisassociateDataSegmentsFromDataset

$result = $client->batchDisassociateDataSegmentsFromDataset([/* ... */]);
$promise = $client->batchDisassociateDataSegmentsFromDatasetAsync([/* ... */]);

Disassociates a batch of data segments from a curated dataset. Disassociating a data segment doesn't delete the underlying data in the source session dataset.

Parameter Syntax

$result = $client->batchDisassociateDataSegmentsFromDataset([
    'clientToken' => '<string>',
    'datasetId' => '<string>', // REQUIRED
    'disassociateDataSegmentEntries' => [ // REQUIRED
        [
            'endTimestamp' => [ // REQUIRED
                'offsetInNanos' => <integer>,
                'timeInSeconds' => <integer>, // REQUIRED
            ],
            'sourceDatasetId' => '<string>', // REQUIRED
            'startTimestamp' => [ // REQUIRED
                'offsetInNanos' => <integer>,
                'timeInSeconds' => <integer>, // REQUIRED
            ],
            'timeSeriesId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'workspaceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'datasetId' => '<string>',
    'datasetVersion' => '<string>',
    'failedDisassociations' => [
        [
            'endTimestamp' => [
                'offsetInNanos' => <integer>,
                'timeInSeconds' => <integer>,
            ],
            'errorCode' => 'INTERNAL_FAILURE|VALIDATION_ERROR|RESOURCE_NOT_FOUND|LIMIT_EXCEEDED|CONFLICTING_OPERATION',
            'errorMessage' => '<string>',
            'sourceDatasetId' => '<string>',
            'startTimestamp' => [
                'offsetInNanos' => <integer>,
                'timeInSeconds' => <integer>,
            ],
            'timeSeriesId' => '<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.

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.

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

CancelEnrichmentJob

$result = $client->cancelEnrichmentJob([/* ... */]);
$promise = $client->cancelEnrichmentJobAsync([/* ... */]);

Cancels a running or pending enrichment job. This is an idempotent operation—calling it multiple times with the same jobId is safe and returns the current status.

Behavior

• Jobs in PENDING or RUNNING status transition to CANCELLED
• Jobs in RUNNING state may not be cancellable once they have progressed to certain processing stages
• Jobs already in terminal states (COMPLETED, FAILED, TIMED_OUT) cannot be cancelled; the operation returns a ConflictingOperationException
• Cancelling an already-CANCELLED job is a no-op and returns the current status (idempotent behavior)
• The API responds immediately after recording the cancellation
• Cleanup of job resources happens asynchronously in the background

When to Cancel

Cancel a job when:

• The job is taking longer than expected
• The job was created with incorrect parameters
• You no longer need the results

Idempotency

You can safely retry cancellation requests. Calling CancelEnrichmentJob multiple times for the same job returns the current status without error as long as the job is not in a terminal state other than CANCELLED.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'jobId' => '<string>',
    'status' => 'PENDING|RUNNING|COMPLETED|FAILED|TIMED_OUT|CANCELLED',
]

Result Details

Errors

InternalFailureException:

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

AccessDeniedException:

Access is denied.

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.

ResourceNotFoundException:

The requested resource can't be found.

LimitExceededException:

You've reached the quota 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.

CancelPipelineExecution

$result = $client->cancelPipelineExecution([/* ... */]);
$promise = $client->cancelPipelineExecutionAsync([/* ... */]);

Cancels a pipeline execution in the specified workspace. If the execution is not in a terminal state (such as NOT_STARTED or RUNNING), it transitions to CANCELLING and asynchronously to CANCELLED. This operation is idempotent: calling it on an execution that is already CANCELLING or CANCELLED returns success with the current state. Calling it on a terminal execution (SUCCEEDED or FAILED) returns a conflict error. You can optionally provide a reason; it is returned in the stateDetails field when you describe the execution.

Parameter Syntax

$result = $client->cancelPipelineExecution([
    'pipelineExecutionId' => '<string>', // REQUIRED
    'pipelineName' => '<string>', // REQUIRED
    'reason' => '<string>',
    'workspaceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'state' => 'NOT_STARTED|RUNNING|SUCCEEDED|FAILED|CANCELLING|CANCELLED',
]

Result Details

Errors

InternalFailureException:

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

AccessDeniedException:

Access is denied.

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.

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.

CancelQuery

$result = $client->cancelQuery([/* ... */]);
$promise = $client->cancelQueryAsync([/* ... */]);

Cancels a running query.

Parameter Syntax

$result = $client->cancelQuery([
    'queryId' => '<string>', // REQUIRED
    'workspaceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'queryId' => '<string>',
    'status' => 'SUBMITTED|RUNNING|COMPLETED|FAILED|CANCELED|CANCELING',
]

Result Details

Errors

InternalFailureException:

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

AccessDeniedException:

Access is denied.

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.

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.

CreateAccessPolicy

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

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

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

CreateApplication

$result = $client->createApplication([/* ... */]);
$promise = $client->createApplicationAsync([/* ... */]);

Creates a new application for the workspace and IdC application provided

Parameter Syntax

$result = $client->createApplication([
    'clientToken' => '<string>',
    'description' => '<string>',
    'idcInstanceArn' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'workspaceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'dnsSubdomain' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'status' => 'CREATING|ACTIVE|DELETING',
]

Result Details

Errors

InternalFailureException:

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

AccessDeniedException:

Access is denied.

ThrottlingException:

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

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

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.

LimitExceededException:

You've reached the quota 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.

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 quota 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 three types of asset models, ASSET_MODEL, COMPONENT_MODEL, or an INTERFACE.

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

• INTERFACE – An interface is a type of model that defines a standard structure that can be applied to different asset models.

Parameter Syntax

$result = $client->createAssetModel([
    'assetModelCompositeModels' => [
        [
            'description' => '<string>',
            'externalId' => '<string>',
            'id' => '<string>',
            'name' => '<string>', // REQUIRED
            'properties' => [
                [
                    'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT|VIDEO|ANNOTATION|JSON', // 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>',
                            'processingConfig' => [
                                'computeLocation' => 'EDGE|CLOUD', // REQUIRED
                            ],
                            'variables' => [
                                [
                                    '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|VIDEO|ANNOTATION|JSON', // 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>',
                    'processingConfig' => [
                        'computeLocation' => 'EDGE|CLOUD', // REQUIRED
                    ],
                    'variables' => [
                        [
                            '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|INTERFACE',
    '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 quota 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|VIDEO|ANNOTATION|JSON', // 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>',
                    'processingConfig' => [
                        'computeLocation' => 'EDGE|CLOUD', // REQUIRED
                    ],
                    'variables' => [
                        [
                            '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>',
        ],
        // ...
    ],
    '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

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 quota 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,
    'datasetId' => '<string>',
    'deleteFilesAfterImport' => true || false,
    'errorReportLocation' => [ // REQUIRED
        'bucket' => '<string>', // REQUIRED
        'prefix' => '<string>', // REQUIRED
    ],
    'files' => [ // REQUIRED
        [
            'alias' => '<string>',
            'bucket' => '<string>', // REQUIRED
            'fileFormat' => [
                'annotation' => [
                ],
                'csv' => [
                    'columnNames' => ['<string>', ...], // REQUIRED
                ],
                'mp4' => [
                ],
                'parquet' => [
                ],
            ],
            'key' => '<string>', // REQUIRED
            'startTime' => [
                'offsetInNanos' => <integer>,
                'timeInSeconds' => <integer>, // REQUIRED
            ],
            'versionId' => '<string>',
        ],
        // ...
    ],
    'jobConfiguration' => [
        'fileFormat' => [
            'annotation' => [
            ],
            'csv' => [
                'columnNames' => ['<string>', ...], // REQUIRED
            ],
            'mp4' => [
            ],
            'parquet' => [
            ],
        ],
    ],
    'jobName' => '<string>', // REQUIRED
    'jobRoleArn' => '<string>', // REQUIRED
    'workspaceName' => '<string>',
]);

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

CreateComputationModel

$result = $client->createComputationModel([/* ... */]);
$promise = $client->createComputationModelAsync([/* ... */]);

Create a computation model with a configuration and data binding.

Parameter Syntax

$result = $client->createComputationModel([
    'clientToken' => '<string>',
    'computationModelConfiguration' => [ // REQUIRED
        'anomalyDetection' => [
            'inputProperties' => '<string>', // REQUIRED
            'resultProperty' => '<string>', // REQUIRED
        ],
    ],
    'computationModelDataBinding' => [ // REQUIRED
        '<ComputationModelDataBindingVariable>' => [
            'assetModelProperty' => [
                'assetModelId' => '<string>', // REQUIRED
                'propertyId' => '<string>', // REQUIRED
            ],
            'assetProperty' => [
                'assetId' => '<string>', // REQUIRED
                'propertyId' => '<string>', // REQUIRED
            ],
            'list' => [
                [...], // RECURSIVE
                // ...
            ],
        ],
        // ...
    ],
    'computationModelDescription' => '<string>',
    'computationModelName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'computationModelArn' => '<string>',
    'computationModelId' => '<string>',
    'computationModelStatus' => [
        '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 quota 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([/* ... */]);

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

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 quota 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. Session and curated datasets are created in a workspace. A session dataset contains data segments of time series data, and a curated dataset curates data segments selected from source session datasets. A dataset that connects to an external datasource is created outside of a workspace.

Parameter Syntax

$result = $client->createDataset([
    'clientToken' => '<string>',
    'datasetConfig' => [
        'session' => [
            'sessionEndTimestamp' => [ // REQUIRED
                'offsetInNanos' => <integer>,
                'timeInSeconds' => <integer>, // REQUIRED
            ],
            'sessionStartTimestamp' => [ // REQUIRED
                'offsetInNanos' => <integer>,
                'timeInSeconds' => <integer>, // REQUIRED
            ],
        ],
    ],
    'datasetDescription' => '<string>',
    'datasetId' => '<string>',
    'datasetName' => '<string>', // REQUIRED
    'datasetSource' => [ // REQUIRED
        'sourceDetail' => [
            'kendra' => [
                'knowledgeBaseArn' => '<string>', // REQUIRED
                'roleArn' => '<string>', // REQUIRED
            ],
        ],
        'sourceFormat' => 'KNOWLEDGE_BASE|TIMESERIES', // REQUIRED
        'sourceType' => 'KENDRA|SITEWISE', // REQUIRED
    ],
    'datasetType' => 'SESSION|CURATED|EXTERNAL',
    'metadata' => ['<string>', ...],
    'tags' => ['<string>', ...],
    'workspaceName' => '<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 quota 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.

CreateDatasetExportJob

$result = $client->createDatasetExportJob([/* ... */]);
$promise = $client->createDatasetExportJobAsync([/* ... */]);

Starts an asynchronous job that exports dataset and time-series data from a workspace to Amazon S3. The operation returns a jobId immediately; poll DescribeDatasetExportJob to track progress and ListDatasetExportJobs to enumerate a workspace's jobs.

Parameter Syntax

$result = $client->createDatasetExportJob([
    'clientToken' => '<string>',
    'destinationS3Uri' => '<string>', // REQUIRED
    'errorReportLocation' => [ // REQUIRED
        's3Uri' => '<string>', // REQUIRED
    ],
    'input' => [ // REQUIRED
        'dataset' => [
            'datasetId' => '<string>', // REQUIRED
            'exportDataTypes' => ['<string>', ...],
            'trimSettings' => [
                'endTime' => [ // REQUIRED
                    'offsetInNanos' => <integer>,
                    'timeInSeconds' => <integer>, // REQUIRED
                ],
                'startTime' => [ // REQUIRED
                    'offsetInNanos' => <integer>,
                    'timeInSeconds' => <integer>, // REQUIRED
                ],
            ],
        ],
        'timeseries' => [
            [
                'formatSettings' => [
                    'framesPerSecond' => <integer>,
                    'heightInPixels' => <integer>,
                    'widthInPixels' => <integer>,
                ],
                'propertyAlias' => '<string>',
                'timeSeriesId' => '<string>',
                'trimSettings' => [
                    'endTime' => [ // REQUIRED
                        'offsetInNanos' => <integer>,
                        'timeInSeconds' => <integer>, // REQUIRED
                    ],
                    'startTime' => [ // REQUIRED
                        'offsetInNanos' => <integer>,
                        'timeInSeconds' => <integer>, // REQUIRED
                    ],
                ],
            ],
            // ...
        ],
    ],
    'workspaceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'jobId' => '<string>',
    'workspaceName' => '<string>',
]

Result Details

Errors

InternalFailureException:

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

AccessDeniedException:

Access is denied.

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.

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.

CreateEnrichmentJob

$result = $client->createEnrichmentJob([/* ... */]);
$promise = $client->createEnrichmentJobAsync([/* ... */]);

Creates an asynchronous enrichment job to analyze time-series sensor data. The operation returns immediately with job details while processing continues in the background.

Idempotency

Include a clientToken to make the operation idempotent. If you submit the same request with the same token within the idempotency window, you receive the original job details without creating a duplicate.

Prerequisites

Before creating a job, ensure:

• The workspace is in ACTIVE state (not being deleted)
• You have IAM permissions for the workspace, dataset, and time-series resources
• You have KMS Decrypt permission on the workspace's customer-managed encryption key
• No duplicate job (same workspace, dataset, property, and job type) is currently running

Workflow

1. Submit the job with configuration specifying which video data to analyze and the time range
2. Capture the jobId from the response
3. Use DescribeEnrichmentJob to monitor progress and check job status
4. When status reaches a terminal state (COMPLETED, FAILED, TIMED_OUT, CANCELLED), check results
5. For COMPLETED jobs, query IoT SiteWise for semantic search on video events

Error Handling

• ConflictingOperationException: A duplicate job is already running for the same configuration
• InvalidRequestException: Invalid parameters (e.g., both timeSeriesId and propertyAlias specified)
• AccessDeniedException: Insufficient IAM or KMS permissions
• LimitExceededException: Too many concurrent jobs or requests

Parameter Syntax

$result = $client->createEnrichmentJob([
    'clientToken' => '<string>',
    'jobConfiguration' => [ // REQUIRED
        'eventDetection' => [
            'datasetId' => '<string>', // REQUIRED
            'propertyAlias' => '<string>',
            'timeSeriesId' => '<string>',
            'trimSettings' => [ // REQUIRED
                'endTime' => [ // REQUIRED
                    'offsetInNanos' => <integer>,
                    'timeInSeconds' => <integer>, // REQUIRED
                ],
                'startTime' => [ // REQUIRED
                    'offsetInNanos' => <integer>,
                    'timeInSeconds' => <integer>, // REQUIRED
                ],
            ],
        ],
    ],
    'workspaceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'jobId' => '<string>',
    'status' => 'PENDING|RUNNING|COMPLETED|FAILED|TIMED_OUT|CANCELLED',
]

Result Details

Errors

InternalFailureException:

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

AccessDeniedException:

Access is denied.

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.

LimitExceededException:

You've reached the quota 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.

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.

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

CreatePipeline

$result = $client->createPipeline([/* ... */]);
$promise = $client->createPipelineAsync([/* ... */]);

Creates a new pipeline in the specified workspace. A pipeline defines a directed acyclic graph (DAG) of compute nodes, where each node references a task and can declare dependencies on other nodes. Cyclic dependencies are not allowed. Nodes without dependencies run in parallel, while nodes with dependencies wait for all upstream nodes to complete successfully before starting.

You can set environment variables at the pipeline level that are shared across all compute nodes, and override them at the individual compute node level.

Parameter Syntax

$result = $client->createPipeline([
    'clientToken' => '<string>',
    'computations' => [ // REQUIRED
        [
            'computeNodeName' => '<string>', // REQUIRED
            'dependsOn' => ['<string>', ...],
            'environmentVariables' => ['<string>', ...],
            'taskName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'description' => '<string>',
    'environmentVariables' => ['<string>', ...],
    'pipelineName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'workspaceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'pipelineArn' => '<string>',
    'pipelineName' => '<string>',
    'status' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            'message' => '<string>',
        ],
        'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED',
    ],
    'version' => '<string>',
]

Result Details

Errors

InternalFailureException:

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

AccessDeniedException:

Access is denied.

LimitExceededException:

You've reached the quota 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.

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.

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.

CreatePortal

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

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

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 quota 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([/* ... */]);

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

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

CreateTask

$result = $client->createTask([/* ... */]);
$promise = $client->createTaskAsync([/* ... */]);

Creates a new task in the specified workspace. A task defines a reusable containerized compute workload that can be referenced by one or more pipeline compute nodes.

Specify a containerTaskConfiguration for custom container workloads with configurable ECR image, processing type, processing unit, and environment variables.

Parameter Syntax

$result = $client->createTask([
    'clientToken' => '<string>',
    'description' => '<string>',
    'tags' => ['<string>', ...],
    'taskConfiguration' => [ // REQUIRED
        'containerTaskConfiguration' => [
            'command' => ['<string>', ...],
            'ecrUri' => '<string>', // REQUIRED
            'environmentVariables' => ['<string>', ...],
            'processingType' => 'GENERIC_COMPUTE_PROCESSING|HARDWARE_ACCELERATED_PROCESSING', // REQUIRED
            'processingUnit' => 'UNITS_2|UNITS_4|UNITS_8|UNITS_12|UNITS_16|UNITS_24|UNITS_32|UNITS_36|UNITS_48|UNITS_60|UNITS_64|UNITS_72|UNITS_84|UNITS_96', // REQUIRED
            'taskExecutionRole' => '<string>', // REQUIRED
            'timeoutSeconds' => <integer>,
        ],
    ],
    'taskName' => '<string>', // REQUIRED
    'workspaceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'status' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            'message' => '<string>',
        ],
        'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED',
    ],
    'taskArn' => '<string>',
    'taskName' => '<string>',
    'version' => '<string>',
]

Result Details

Errors

InternalFailureException:

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

AccessDeniedException:

Access is denied.

LimitExceededException:

You've reached the quota 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.

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.

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.

CreateWorkspace

$result = $client->createWorkspace([/* ... */]);
$promise = $client->createWorkspaceAsync([/* ... */]);

Creates a workspace in IoT SiteWise. A workspace isolates its resources, such as datasets, time series, pipelines, and tasks, and their data from other workspaces, and has its own quotas and throttling limits. You must specify an encryption configuration when you create a workspace. The operation returns immediately with the workspace in the CREATING state. Provisioning completes asynchronously, after which the workspace state is ACTIVE, or FAILED if provisioning doesn't complete.

Parameter Syntax

$result = $client->createWorkspace([
    'clientToken' => '<string>',
    'encryptionConfiguration' => [ // REQUIRED
        'encryptionType' => 'SITEWISE_DEFAULT_ENCRYPTION|KMS_BASED_ENCRYPTION', // REQUIRED
        'kmsKeyId' => '<string>',
    ],
    'tags' => ['<string>', ...],
    'workspaceDescription' => '<string>',
    'workspaceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'workspaceArn' => '<string>',
    'workspaceName' => '<string>',
    'workspaceStatus' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            'message' => '<string>',
        ],
        'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED',
    ],
]

Result Details

Errors

AccessDeniedException:

Access is denied.

InvalidRequestException:

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

ConflictingOperationException:

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

LimitExceededException:

You've reached the quota 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.

InternalFailureException:

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

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.

DeleteApplication

$result = $client->deleteApplication([/* ... */]);
$promise = $client->deleteApplicationAsync([/* ... */]);

Deletes an application by ID

Parameter Syntax

$result = $client->deleteApplication([
    'id' => '<string>', // REQUIRED
    'workspaceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalFailureException:

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

AccessDeniedException:

Access is denied.

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.

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.

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

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

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

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

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

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

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.

DeleteAssetModelInterfaceRelationship

$result = $client->deleteAssetModelInterfaceRelationship([/* ... */]);
$promise = $client->deleteAssetModelInterfaceRelationshipAsync([/* ... */]);

Deletes an interface relationship between an asset model and an interface asset model.

Parameter Syntax

$result = $client->deleteAssetModelInterfaceRelationship([
    'assetModelId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'interfaceAssetModelId' => '<string>', // REQUIRED
]);

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',
    ],
    'interfaceAssetModelId' => '<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.

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.

DeleteComputationModel

$result = $client->deleteComputationModel([/* ... */]);
$promise = $client->deleteComputationModelAsync([/* ... */]);

Deletes a computation model. This action can't be undone.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'computationModelStatus' => [
        '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.

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 can't be undone. Deleting a session dataset also deletes the underlying time series data in the session. You can't delete a session dataset while a curated dataset references its data segments. First delete the curated dataset or disassociate the data segments. Deleting a curated dataset doesn't delete the underlying data in the source session datasets.

Parameter Syntax

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

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.

DeletePipeline

$result = $client->deletePipeline([/* ... */]);
$promise = $client->deletePipelineAsync([/* ... */]);

Deletes a pipeline from the specified workspace. A pipeline cannot be deleted if it has any active executions. Wait for all executions to complete before attempting to delete the pipeline, or use CancelPipelineExecution to stop a running execution.

Parameter Syntax

$result = $client->deletePipeline([
    'pipelineName' => '<string>', // REQUIRED
    'workspaceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InternalFailureException:

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

AccessDeniedException:

Access is denied.

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.

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.

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.

DeleteTask

$result = $client->deleteTask([/* ... */]);
$promise = $client->deleteTaskAsync([/* ... */]);

Deletes a task from the specified workspace. A task cannot be deleted if it is currently referenced by any existing pipeline. Remove the task from all pipelines before attempting to delete it.

Parameter Syntax

$result = $client->deleteTask([
    'taskName' => '<string>', // REQUIRED
    'workspaceName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InternalFailureException:

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

AccessDeniedException:

Access is denied.

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.

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.

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. You can't delete a time series until all of its data segments have been deleted from session datasets.

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>',
    'workspaceName' => '<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.

DeleteWorkspace

$result = $client->deleteWorkspace([/* ... */]);
$promise = $client->deleteWorkspaceAsync([/* ... */]);

Deletes a workspace. Before you delete a workspace, you must delete all resources contained in or associated with the workspace, such as datasets, time series, pipelines, and tasks.