AWS IoT SiteWise 2019-12-02

AssociateAssets

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

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.

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• LimitExceededException:

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

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

• ThrottlingException:

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

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

• ConflictingOperationException:

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

BatchAssociateProjectAssets

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InvalidRequestException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

• LimitExceededException:

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

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

BatchDisassociateProjectAssets

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

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.

BatchPutAssetPropertyValue

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

Parameter Syntax

$result = $client->batchPutAssetPropertyValue([
    'entries' => [ // REQUIRED
        [
            'assetId' => '<string>',
            'entryId' => '<string>', // REQUIRED
            'propertyAlias' => '<string>',
            'propertyId' => '<string>',
            'propertyValues' => [ // REQUIRED
                [
                    'quality' => 'GOOD|BAD|UNCERTAIN',
                    'timestamp' => [ // REQUIRED
                        'offsetInNanos' => <integer>,
                        'timeInSeconds' => <integer>, // REQUIRED
                    ],
                    'value' => [ // REQUIRED
                        'booleanValue' => true || false,
                        'doubleValue' => <float>,
                        'integerValue' => <integer>,
                        'stringValue' => '<string>',
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'errorEntries' => [
        [
            'entryId' => '<string>',
            'errors' => [
                [
                    'errorCode' => 'ResourceNotFoundException|InvalidRequestException|InternalFailureException|ServiceUnavailableException|ThrottlingException|LimitExceededException|ConflictingOperationException|TimestampOutOfRangeException|AccessDeniedException',
                    'errorMessage' => '<string>',
                    'timestamps' => [
                        [
                            'offsetInNanos' => <integer>,
                            'timeInSeconds' => <integer>,
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

• InvalidRequestException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

• LimitExceededException:

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

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

• ServiceUnavailableException:

  The requested service is unavailable.

• ConflictingOperationException:

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

CreateAccessPolicy

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InvalidRequestException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

• LimitExceededException:

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

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

CreateAsset

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

Parameter Syntax

$result = $client->createAsset([
    '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',
            'message' => '<string>',
        ],
        'state' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED',
    ],
]

Result Details

Errors

• InvalidRequestException:

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

• ResourceAlreadyExistsException:

  The resource already exists.

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

• LimitExceededException:

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

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

• ConflictingOperationException:

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

CreateAssetModel

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

Parameter Syntax

$result = $client->createAssetModel([
    'assetModelCompositeModels' => [
        [
            'description' => '<string>',
            'name' => '<string>', // REQUIRED
            'properties' => [
                [
                    'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', // REQUIRED
                    'dataTypeSpec' => '<string>',
                    'name' => '<string>', // REQUIRED
                    'type' => [ // REQUIRED
                        'attribute' => [
                            'defaultValue' => '<string>',
                        ],
                        'measurement' => [
                        ],
                        'metric' => [
                            'expression' => '<string>', // REQUIRED
                            'variables' => [ // REQUIRED
                                [
                                    'name' => '<string>', // REQUIRED
                                    'value' => [ // REQUIRED
                                        'hierarchyId' => '<string>',
                                        'propertyId' => '<string>', // REQUIRED
                                    ],
                                ],
                                // ...
                            ],
                            'window' => [ // REQUIRED
                                'tumbling' => [
                                    'interval' => '<string>', // REQUIRED
                                ],
                            ],
                        ],
                        'transform' => [
                            'expression' => '<string>', // REQUIRED
                            'variables' => [ // REQUIRED
                                [
                                    'name' => '<string>', // REQUIRED
                                    'value' => [ // REQUIRED
                                        'hierarchyId' => '<string>',
                                        'propertyId' => '<string>', // REQUIRED
                                    ],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'unit' => '<string>',
                ],
                // ...
            ],
            'type' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'assetModelDescription' => '<string>',
    'assetModelHierarchies' => [
        [
            'childAssetModelId' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'assetModelName' => '<string>', // REQUIRED
    'assetModelProperties' => [
        [
            'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT', // REQUIRED
            'dataTypeSpec' => '<string>',
            'name' => '<string>', // REQUIRED
            'type' => [ // REQUIRED
                'attribute' => [
                    'defaultValue' => '<string>',
                ],
                'measurement' => [
                ],
                'metric' => [
                    'expression' => '<string>', // REQUIRED
                    'variables' => [ // REQUIRED
                        [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'hierarchyId' => '<string>',
                                'propertyId' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                    'window' => [ // REQUIRED
                        'tumbling' => [
                            'interval' => '<string>', // REQUIRED
                        ],
                    ],
                ],
                'transform' => [
                    'expression' => '<string>', // REQUIRED
                    'variables' => [ // REQUIRED
                        [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'hierarchyId' => '<string>',
                                'propertyId' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            'unit' => '<string>',
        ],
        // ...
    ],
    'clientToken' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• InvalidRequestException:

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

• ResourceAlreadyExistsException:

  The resource already exists.

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

• LimitExceededException:

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

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

• ConflictingOperationException:

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

CreateDashboard

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InvalidRequestException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

• LimitExceededException:

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

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

CreateGateway

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

Parameter Syntax

$result = $client->createGateway([
    'gatewayName' => '<string>', // REQUIRED
    'gatewayPlatform' => [ // REQUIRED
        'greengrass' => [ // REQUIRED
            'groupArn' => '<string>', // REQUIRED
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• InvalidRequestException:

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

• ResourceAlreadyExistsException:

  The resource already exists.

• InternalFailureException:

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

• ThrottlingException:

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

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

• LimitExceededException:

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

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

CreatePortal

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

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
    '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|UPDATING|DELETING|ACTIVE|FAILED',
    ],
    'ssoApplicationId' => '<string>',
]

Result Details

Errors

• InvalidRequestException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

• LimitExceededException:

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

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

CreateProject

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InvalidRequestException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

• LimitExceededException:

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

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

DeleteAccessPolicy

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• InvalidRequestException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

DeleteAsset

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'assetStatus' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            '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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'assetModelStatus' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            '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.

DeleteDashboard

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

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.

DeleteGateway

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

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.

• InternalFailureException:

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

• ThrottlingException:

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

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

DeletePortal

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

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

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.

DescribeAccessPolicy

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InvalidRequestException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

DescribeAsset

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InvalidRequestException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

DescribeAssetModel

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'assetModelArn' => '<string>',
    'assetModelCompositeModels' => [
        [
            'description' => '<string>',
            'name' => '<string>',
            'properties' => [
                [
                    'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT',
                    'dataTypeSpec' => '<string>',
                    'id' => '<string>',
                    'name' => '<string>',
                    'type' => [
                        'attribute' => [
                            'defaultValue' => '<string>',
                        ],
                        'measurement' => [
                        ],
                        'metric' => [
                            'expression' => '<string>',
                            'variables' => [
                                [
                                    'name' => '<string>',
                                    'value' => [
                                        'hierarchyId' => '<string>',
                                        'propertyId' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                            'window' => [
                                'tumbling' => [
                                    'interval' => '<string>',
                                ],
                            ],
                        ],
                        'transform' => [
                            'expression' => '<string>',
                            'variables' => [
                                [
                                    'name' => '<string>',
                                    'value' => [
                                        'hierarchyId' => '<string>',
                                        'propertyId' => '<string>',
                                    ],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'unit' => '<string>',
                ],
                // ...
            ],
            'type' => '<string>',
        ],
        // ...
    ],
    'assetModelCreationDate' => <DateTime>,
    'assetModelDescription' => '<string>',
    'assetModelHierarchies' => [
        [
            'childAssetModelId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'assetModelId' => '<string>',
    'assetModelLastUpdateDate' => <DateTime>,
    'assetModelName' => '<string>',
    'assetModelProperties' => [
        [
            'dataType' => 'STRING|INTEGER|DOUBLE|BOOLEAN|STRUCT',
            'dataTypeSpec' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'type' => [
                'attribute' => [
                    'defaultValue' => '<string>',
                ],
                'measurement' => [
                ],
                'metric' => [
                    'expression' => '<string>',
                    'variables' => [
                        [
                            'name' => '<string>',
                            'value' => [
                                'hierarchyId' => '<string>',
                                'propertyId' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'window' => [
                        'tumbling' => [
                            'interval' => '<string>',
                        ],
                    ],
                ],
                'transform' => [
                    'expression' => '<string>',
                    'variables' => [
                        [
                            'name' => '<string>',
                            'value' => [
                                'hierarchyId' => '<string>',
                                'propertyId' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            'unit' => '<string>',
        ],
        // ...
    ],
    'assetModelStatus' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            'message' => '<string>',
        ],
        'state' => 'CREATING|ACTIVE|UPDATING|PROPAGATING|DELETING|FAILED',
    ],
]

Result Details

Errors

• InvalidRequestException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

DescribeAssetProperty

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InvalidRequestException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

DescribeDashboard

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InvalidRequestException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

DescribeDefaultEncryptionConfiguration

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'configurationStatus' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            'message' => '<string>',
        ],
        'state' => 'ACTIVE|UPDATE_IN_PROGRESS|UPDATE_FAILED',
    ],
    'encryptionType' => 'SITEWISE_DEFAULT_ENCRYPTION|KMS_BASED_ENCRYPTION',
    'kmsKeyArn' => '<string>',
]

Result Details

Errors

• InvalidRequestException:

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

• InternalFailureException:

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

• ThrottlingException:

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

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

DescribeGateway

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'creationDate' => <DateTime>,
    'gatewayArn' => '<string>',
    'gatewayCapabilitySummaries' => [
        [
            'capabilityNamespace' => '<string>',
            'capabilitySyncStatus' => 'IN_SYNC|OUT_OF_SYNC|SYNC_FAILED',
        ],
        // ...
    ],
    'gatewayId' => '<string>',
    'gatewayName' => '<string>',
    'gatewayPlatform' => [
        'greengrass' => [
            'groupArn' => '<string>',
        ],
    ],
    'lastUpdateDate' => <DateTime>,
]

Result Details

Errors

• InvalidRequestException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

DescribeGatewayCapabilityConfiguration

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InvalidRequestException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

DescribeLoggingOptions

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InvalidRequestException:

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

• ThrottlingException:

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

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

• InternalFailureException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

DescribePortal

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InvalidRequestException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

DescribeProject

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• InvalidRequestException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

DescribeStorageConfiguration

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'configurationStatus' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE',
            'message' => '<string>',
        ],
        'state' => 'ACTIVE|UPDATE_IN_PROGRESS|UPDATE_FAILED',
    ],
    'lastUpdateDate' => <DateTime>,
    'multiLayerStorage' => [
        'customerManagedS3Storage' => [
            'roleArn' => '<string>',
            's3ResourceArn' => '<string>',
        ],
    ],
    'storageType' => 'SITEWISE_DEFAULT_STORAGE|MULTI_LAYER_STORAGE',
]

Result Details

Errors

• InvalidRequestException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

• LimitExceededException:

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

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

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

DisassociateAssets

$result = $client->disassociateAssets([/* ... */]);
$promise = $client->disassociateAssetsAsync([/* ... */]);

Parameter Syntax

$result = $client->disassociateAssets([
    '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.

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

GetAssetPropertyAggregates

$result = $client->getAssetPropertyAggregates([/* ... */]);
$promise = $client->getAssetPropertyAggregatesAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'aggregatedValues' => [
        [
            'quality' => 'GOOD|BAD|UNCERTAIN',
            'timestamp' => <DateTime>,
            'value' => [
                'average' => <float>,
                'count' => <float>,
                'maximum' => <float>,
                'minimum' => <float>,
                'standardDeviation' => <float>,
                'sum' => <float>,
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

• InvalidRequestException:

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

• ResourceNotFoundException:

  The requested resource can't be found.

• InternalFailureException:

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

• ThrottlingException:

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

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

• ServiceUnavailableException:

  The requested service is unavailable.

GetAssetPropertyValue

$result = $client->getAssetPropertyValue([/* ... */]);
$promise = $client->getAssetPropertyValueAsync([/* ... */]);

Parameter Syntax

$result = $client->getAssetPropertyValue([
    'assetId' => '<string>',
    'propertyAlias' => '<string>',
    'propertyId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'propertyValue' => [
        'quality' => 'GOOD|BAD|UNCERTAIN',
        'timestamp' => [
            'offsetInNanos' => <integer>,
            'timeInSeconds' => <integer>,
        ],
        'value' => [
            'booleanValue' => true || false,
            'doubleValue' => <float>,
            'integerValue' => <integer>,
            'stringValue' => '<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.

• ServiceUnavailableException:

  The requested service is unavailable.

GetAssetPropertyValueHistory

$result = $client->getAssetPropertyValueHistory([/* ... */]);
$promise = $client->getAssetPropertyValueHistoryAsync([/* ... */]);

Parameter Syntax

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

Parameter Details