Api-Iottwinmaker-2021-11-29 - AWS SDK for PHP V3

Client: Aws\IoTTwinMaker\IoTTwinMakerClient

Service ID: iottwinmaker

Version: 2021-11-29

This page describes the parameters and results for the operations of the AWS IoT TwinMaker (2021-11-29), and shows how to use the Aws\IoTTwinMaker\IoTTwinMakerClient object to call the described operations. This documentation is specific to the 2021-11-29 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

BatchPutPropertyValues ( array $params = [] ): Sets values for multiple time series properties.
CancelMetadataTransferJob ( array $params = [] ): Cancels the metadata transfer job.
CreateComponentType ( array $params = [] ): Creates a component type.
CreateEntity ( array $params = [] ): Creates an entity.
CreateMetadataTransferJob ( array $params = [] ): Creates a new metadata transfer job.
CreateScene ( array $params = [] ): Creates a scene.
CreateSyncJob ( array $params = [] ): This action creates a SyncJob.
CreateWorkspace ( array $params = [] ): Creates a workplace.
DeleteComponentType ( array $params = [] ): Deletes a component type.
DeleteEntity ( array $params = [] ): Deletes an entity.
DeleteScene ( array $params = [] ): Deletes a scene.
DeleteSyncJob ( array $params = [] ): Delete the SyncJob.
DeleteWorkspace ( array $params = [] ): Deletes a workspace.
ExecuteQuery ( array $params = [] ): Run queries to access information from your knowledge graph of entities within individual workspaces.
GetComponentType ( array $params = [] ): Retrieves information about a component type.
GetEntity ( array $params = [] ): Retrieves information about an entity.
GetMetadataTransferJob ( array $params = [] ): Gets a nmetadata transfer job.
GetPricingPlan ( array $params = [] ): Gets the pricing plan.
GetPropertyValue ( array $params = [] ): Gets the property values for a component, component type, entity, or workspace.
GetPropertyValueHistory ( array $params = [] ): Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.
GetScene ( array $params = [] ): Retrieves information about a scene.
GetSyncJob ( array $params = [] ): Gets the SyncJob.
GetWorkspace ( array $params = [] ): Retrieves information about a workspace.
ListComponentTypes ( array $params = [] ): Lists all component types in a workspace.
ListComponents ( array $params = [] ): This API lists the components of an entity.
ListEntities ( array $params = [] ): Lists all entities in a workspace.
ListMetadataTransferJobs ( array $params = [] ): Lists the metadata transfer jobs.
ListProperties ( array $params = [] ): This API lists the properties of a component.
ListScenes ( array $params = [] ): Lists all scenes in a workspace.
ListSyncJobs ( array $params = [] ): List all SyncJobs.
ListSyncResources ( array $params = [] ): Lists the sync resources.
ListTagsForResource ( array $params = [] ): Lists all tags associated with a resource.
ListWorkspaces ( array $params = [] ): Retrieves information about workspaces in the current account.
TagResource ( array $params = [] ): Adds tags to a resource.
UntagResource ( array $params = [] ): Removes tags from a resource.
UpdateComponentType ( array $params = [] ): Updates information in a component type.
UpdateEntity ( array $params = [] ): Updates an entity.
UpdatePricingPlan ( array $params = [] ): Update the pricing plan.
UpdateScene ( array $params = [] ): Updates a scene.
UpdateWorkspace ( array $params = [] ): Updates a workspace.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ExecuteQuery
GetPropertyValue
GetPropertyValueHistory
ListComponentTypes
ListComponents
ListEntities
ListMetadataTransferJobs
ListProperties
ListScenes
ListSyncJobs
ListSyncResources
ListWorkspaces

Operations

BatchPutPropertyValues

$result = $client->batchPutPropertyValues([/* ... */]);
$promise = $client->batchPutPropertyValuesAsync([/* ... */]);

Sets values for multiple time series properties.

Parameter Syntax

$result = $client->batchPutPropertyValues([
    'entries' => [ // REQUIRED
        [
            'entityPropertyReference' => [ // REQUIRED
                'componentName' => '<string>',
                'componentPath' => '<string>',
                'entityId' => '<string>',
                'externalIdProperty' => ['<string>', ...],
                'propertyName' => '<string>', // REQUIRED
            ],
            'propertyValues' => [
                [
                    'time' => '<string>',
                    'timestamp' => <integer || string || DateTime>,
                    'value' => [ // REQUIRED
                        'booleanValue' => true || false,
                        'doubleValue' => <float>,
                        'expression' => '<string>',
                        'integerValue' => <integer>,
                        'listValue' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'longValue' => <integer>,
                        'mapValue' => [
                            '<String>' => [...], // RECURSIVE
                            // ...
                        ],
                        'relationshipValue' => [
                            'targetComponentName' => '<string>',
                            'targetEntityId' => '<string>',
                        ],
                        'stringValue' => '<string>',
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

entries

: Required: Yes
: Type: Array of PropertyValueEntry structures

An object that maps strings to the property value entries to set. Each string in the mapping must be unique to this object.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace that contains the properties to set.

Result Syntax

[
    'errorEntries' => [
        [
            'errors' => [
                [
                    'entry' => [
                        'entityPropertyReference' => [
                            'componentName' => '<string>',
                            'componentPath' => '<string>',
                            'entityId' => '<string>',
                            'externalIdProperty' => ['<string>', ...],
                            'propertyName' => '<string>',
                        ],
                        'propertyValues' => [
                            [
                                'time' => '<string>',
                                'timestamp' => <DateTime>,
                                'value' => [
                                    'booleanValue' => true || false,
                                    'doubleValue' => <float>,
                                    'expression' => '<string>',
                                    'integerValue' => <integer>,
                                    'listValue' => [
                                        [...], // RECURSIVE
                                        // ...
                                    ],
                                    'longValue' => <integer>,
                                    'mapValue' => [
                                        '<String>' => [...], // RECURSIVE
                                        // ...
                                    ],
                                    'relationshipValue' => [
                                        'targetComponentName' => '<string>',
                                        'targetEntityId' => '<string>',
                                    ],
                                    'stringValue' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    'errorCode' => '<string>',
                    'errorMessage' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members

errorEntries

: Required: Yes
: Type: Array of BatchPutPropertyErrorEntry structures

Entries that caused errors in the batch put operation.

Errors

InternalServerException:: An unexpected error has occurred.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed

CancelMetadataTransferJob

$result = $client->cancelMetadataTransferJob([/* ... */]);
$promise = $client->cancelMetadataTransferJobAsync([/* ... */]);

Cancels the metadata transfer job.

Parameter Syntax

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

Parameter Details

Members

metadataTransferJobId

: Required: Yes
: Type: string

The metadata transfer job Id.

Result Syntax

[
    'arn' => '<string>',
    'metadataTransferJobId' => '<string>',
    'progress' => [
        'failedCount' => <integer>,
        'skippedCount' => <integer>,
        'succeededCount' => <integer>,
        'totalCount' => <integer>,
    ],
    'status' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE|SYNC_INITIALIZING_ERROR|SYNC_CREATING_ERROR|SYNC_PROCESSING_ERROR|SYNC_DELETING_ERROR|PROCESSING_ERROR|COMPOSITE_COMPONENT_FAILURE',
            'message' => '<string>',
        ],
        'queuedPosition' => <integer>,
        'state' => 'VALIDATING|PENDING|RUNNING|CANCELLING|ERROR|COMPLETED|CANCELLED',
    ],
    'updateDateTime' => <DateTime>,
]

Result Details

Members

arn

: Required: Yes
: Type: string

The metadata transfer job ARN.

metadataTransferJobId

: Required: Yes
: Type: string

The metadata transfer job Id.

progress

: Type: MetadataTransferJobProgress structure

The metadata transfer job's progress.

status

: Required: Yes
: Type: MetadataTransferJobStatus structure

The metadata transfer job's status.

updateDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

Used to update the DateTime property.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ConflictException:: A conflict occurred.

CreateComponentType

$result = $client->createComponentType([/* ... */]);
$promise = $client->createComponentTypeAsync([/* ... */]);

Creates a component type.

Parameter Syntax

$result = $client->createComponentType([
    'componentTypeId' => '<string>', // REQUIRED
    'componentTypeName' => '<string>',
    'compositeComponentTypes' => [
        '<Name>' => [
            'componentTypeId' => '<string>',
        ],
        // ...
    ],
    'description' => '<string>',
    'extendsFrom' => ['<string>', ...],
    'functions' => [
        '<Name>' => [
            'implementedBy' => [
                'isNative' => true || false,
                'lambda' => [
                    'arn' => '<string>', // REQUIRED
                ],
            ],
            'requiredProperties' => ['<string>', ...],
            'scope' => 'ENTITY|WORKSPACE',
        ],
        // ...
    ],
    'isSingleton' => true || false,
    'propertyDefinitions' => [
        '<Name>' => [
            'configuration' => ['<string>', ...],
            'dataType' => [
                'allowedValues' => [
                    [
                        'booleanValue' => true || false,
                        'doubleValue' => <float>,
                        'expression' => '<string>',
                        'integerValue' => <integer>,
                        'listValue' => [...], // RECURSIVE
                        'longValue' => <integer>,
                        'mapValue' => [
                            '<String>' => [...], // RECURSIVE
                            // ...
                        ],
                        'relationshipValue' => [
                            'targetComponentName' => '<string>',
                            'targetEntityId' => '<string>',
                        ],
                        'stringValue' => '<string>',
                    ],
                    // ...
                ],
                'nestedType' => [...], // RECURSIVE
                'relationship' => [
                    'relationshipType' => '<string>',
                    'targetComponentTypeId' => '<string>',
                ],
                'type' => 'RELATIONSHIP|STRING|LONG|BOOLEAN|INTEGER|DOUBLE|LIST|MAP', // REQUIRED
                'unitOfMeasure' => '<string>',
            ],
            'defaultValue' => [
                'booleanValue' => true || false,
                'doubleValue' => <float>,
                'expression' => '<string>',
                'integerValue' => <integer>,
                'listValue' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'longValue' => <integer>,
                'mapValue' => [
                    '<String>' => [...], // RECURSIVE
                    // ...
                ],
                'relationshipValue' => [
                    'targetComponentName' => '<string>',
                    'targetEntityId' => '<string>',
                ],
                'stringValue' => '<string>',
            ],
            'displayName' => '<string>',
            'isExternalId' => true || false,
            'isRequiredInEntity' => true || false,
            'isStoredExternally' => true || false,
            'isTimeSeries' => true || false,
        ],
        // ...
    ],
    'propertyGroups' => [
        '<Name>' => [
            'groupType' => 'TABULAR',
            'propertyNames' => ['<string>', ...],
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

componentTypeId

: Required: Yes
: Type: string

The ID of the component type.

componentTypeName

: Type: string

A friendly name for the component type.

compositeComponentTypes

: Type: Associative array of custom strings keys (Name) to CompositeComponentTypeRequest structures

This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.

description

: Type: string

The description of the component type.

extendsFrom

: Type: Array of strings

Specifies the parent component type to extend.

functions

: Type: Associative array of custom strings keys (Name) to FunctionRequest structures

An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

isSingleton

: Type: boolean

A Boolean value that specifies whether an entity can have more than one component of this type.

propertyDefinitions

: Type: Associative array of custom strings keys (Name) to PropertyDefinitionRequest structures

An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

propertyGroups

: Type: Associative array of custom strings keys (Name) to PropertyGroupRequest structures

tags

: Type: Associative array of custom strings keys (TagKey) to strings

Metadata that you can use to manage the component type.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace that contains the component type.

Result Syntax

[
    'arn' => '<string>',
    'creationDateTime' => <DateTime>,
    'state' => 'CREATING|UPDATING|DELETING|ACTIVE|ERROR',
]

Result Details

Members

arn

: Required: Yes
: Type: string

The ARN of the component type.

creationDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the entity was created.

state

: Required: Yes
: Type: string

The current state of the component type.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ConflictException:: A conflict occurred.
ServiceQuotaExceededException:: The service quota was exceeded.

CreateEntity

$result = $client->createEntity([/* ... */]);
$promise = $client->createEntityAsync([/* ... */]);

Creates an entity.

Parameter Syntax

$result = $client->createEntity([
    'components' => [
        '<Name>' => [
            'componentTypeId' => '<string>',
            'description' => '<string>',
            'properties' => [
                '<Name>' => [
                    'definition' => [
                        'configuration' => ['<string>', ...],
                        'dataType' => [
                            'allowedValues' => [
                                [
                                    'booleanValue' => true || false,
                                    'doubleValue' => <float>,
                                    'expression' => '<string>',
                                    'integerValue' => <integer>,
                                    'listValue' => [...], // RECURSIVE
                                    'longValue' => <integer>,
                                    'mapValue' => [
                                        '<String>' => [...], // RECURSIVE
                                        // ...
                                    ],
                                    'relationshipValue' => [
                                        'targetComponentName' => '<string>',
                                        'targetEntityId' => '<string>',
                                    ],
                                    'stringValue' => '<string>',
                                ],
                                // ...
                            ],
                            'nestedType' => [...], // RECURSIVE
                            'relationship' => [
                                'relationshipType' => '<string>',
                                'targetComponentTypeId' => '<string>',
                            ],
                            'type' => 'RELATIONSHIP|STRING|LONG|BOOLEAN|INTEGER|DOUBLE|LIST|MAP', // REQUIRED
                            'unitOfMeasure' => '<string>',
                        ],
                        'defaultValue' => [
                            'booleanValue' => true || false,
                            'doubleValue' => <float>,
                            'expression' => '<string>',
                            'integerValue' => <integer>,
                            'listValue' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'longValue' => <integer>,
                            'mapValue' => [
                                '<String>' => [...], // RECURSIVE
                                // ...
                            ],
                            'relationshipValue' => [
                                'targetComponentName' => '<string>',
                                'targetEntityId' => '<string>',
                            ],
                            'stringValue' => '<string>',
                        ],
                        'displayName' => '<string>',
                        'isExternalId' => true || false,
                        'isRequiredInEntity' => true || false,
                        'isStoredExternally' => true || false,
                        'isTimeSeries' => true || false,
                    ],
                    'updateType' => 'UPDATE|DELETE|CREATE|RESET_VALUE',
                    'value' => [
                        'booleanValue' => true || false,
                        'doubleValue' => <float>,
                        'expression' => '<string>',
                        'integerValue' => <integer>,
                        'listValue' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'longValue' => <integer>,
                        'mapValue' => [
                            '<String>' => [...], // RECURSIVE
                            // ...
                        ],
                        'relationshipValue' => [
                            'targetComponentName' => '<string>',
                            'targetEntityId' => '<string>',
                        ],
                        'stringValue' => '<string>',
                    ],
                ],
                // ...
            ],
            'propertyGroups' => [
                '<Name>' => [
                    'groupType' => 'TABULAR',
                    'propertyNames' => ['<string>', ...],
                    'updateType' => 'UPDATE|DELETE|CREATE',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'compositeComponents' => [
        '<ComponentPath>' => [
            'description' => '<string>',
            'properties' => [
                '<Name>' => [
                    'definition' => [
                        'configuration' => ['<string>', ...],
                        'dataType' => [
                            'allowedValues' => [
                                [
                                    'booleanValue' => true || false,
                                    'doubleValue' => <float>,
                                    'expression' => '<string>',
                                    'integerValue' => <integer>,
                                    'listValue' => [...], // RECURSIVE
                                    'longValue' => <integer>,
                                    'mapValue' => [
                                        '<String>' => [...], // RECURSIVE
                                        // ...
                                    ],
                                    'relationshipValue' => [
                                        'targetComponentName' => '<string>',
                                        'targetEntityId' => '<string>',
                                    ],
                                    'stringValue' => '<string>',
                                ],
                                // ...
                            ],
                            'nestedType' => [...], // RECURSIVE
                            'relationship' => [
                                'relationshipType' => '<string>',
                                'targetComponentTypeId' => '<string>',
                            ],
                            'type' => 'RELATIONSHIP|STRING|LONG|BOOLEAN|INTEGER|DOUBLE|LIST|MAP', // REQUIRED
                            'unitOfMeasure' => '<string>',
                        ],
                        'defaultValue' => [
                            'booleanValue' => true || false,
                            'doubleValue' => <float>,
                            'expression' => '<string>',
                            'integerValue' => <integer>,
                            'listValue' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'longValue' => <integer>,
                            'mapValue' => [
                                '<String>' => [...], // RECURSIVE
                                // ...
                            ],
                            'relationshipValue' => [
                                'targetComponentName' => '<string>',
                                'targetEntityId' => '<string>',
                            ],
                            'stringValue' => '<string>',
                        ],
                        'displayName' => '<string>',
                        'isExternalId' => true || false,
                        'isRequiredInEntity' => true || false,
                        'isStoredExternally' => true || false,
                        'isTimeSeries' => true || false,
                    ],
                    'updateType' => 'UPDATE|DELETE|CREATE|RESET_VALUE',
                    'value' => [
                        'booleanValue' => true || false,
                        'doubleValue' => <float>,
                        'expression' => '<string>',
                        'integerValue' => <integer>,
                        'listValue' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'longValue' => <integer>,
                        'mapValue' => [
                            '<String>' => [...], // RECURSIVE
                            // ...
                        ],
                        'relationshipValue' => [
                            'targetComponentName' => '<string>',
                            'targetEntityId' => '<string>',
                        ],
                        'stringValue' => '<string>',
                    ],
                ],
                // ...
            ],
            'propertyGroups' => [
                '<Name>' => [
                    'groupType' => 'TABULAR',
                    'propertyNames' => ['<string>', ...],
                    'updateType' => 'UPDATE|DELETE|CREATE',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'description' => '<string>',
    'entityId' => '<string>',
    'entityName' => '<string>', // REQUIRED
    'parentEntityId' => '<string>',
    'tags' => ['<string>', ...],
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

components

: Type: Associative array of custom strings keys (Name) to ComponentRequest structures

An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

compositeComponents

: Type: Associative array of custom strings keys (ComponentPath) to CompositeComponentRequest structures

This is an object that maps strings to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent.

description

: Type: string

The description of the entity.

entityId

: Type: string

The ID of the entity.

entityName

: Required: Yes
: Type: string

The name of the entity.

parentEntityId

: Type: string

The ID of the entity's parent entity.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

Metadata that you can use to manage the entity.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace that contains the entity.

Result Syntax

[
    'arn' => '<string>',
    'creationDateTime' => <DateTime>,
    'entityId' => '<string>',
    'state' => 'CREATING|UPDATING|DELETING|ACTIVE|ERROR',
]

Result Details

Members

arn

: Required: Yes
: Type: string

The ARN of the entity.

creationDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the entity was created.

entityId

: Required: Yes
: Type: string

The ID of the entity.

state

: Required: Yes
: Type: string

The current state of the entity.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ConflictException:: A conflict occurred.
ServiceQuotaExceededException:: The service quota was exceeded.

CreateMetadataTransferJob

$result = $client->createMetadataTransferJob([/* ... */]);
$promise = $client->createMetadataTransferJobAsync([/* ... */]);

Creates a new metadata transfer job.

Parameter Syntax

$result = $client->createMetadataTransferJob([
    'description' => '<string>',
    'destination' => [ // REQUIRED
        'iotTwinMakerConfiguration' => [
            'workspace' => '<string>', // REQUIRED
        ],
        's3Configuration' => [
            'location' => '<string>', // REQUIRED
        ],
        'type' => 's3|iotsitewise|iottwinmaker', // REQUIRED
    ],
    'metadataTransferJobId' => '<string>',
    'sources' => [ // REQUIRED
        [
            'iotSiteWiseConfiguration' => [
                'filters' => [
                    [
                        'filterByAsset' => [
                            'assetExternalId' => '<string>',
                            'assetId' => '<string>',
                            'includeAssetModel' => true || false,
                            'includeOffspring' => true || false,
                        ],
                        'filterByAssetModel' => [
                            'assetModelExternalId' => '<string>',
                            'assetModelId' => '<string>',
                            'includeAssets' => true || false,
                            'includeOffspring' => true || false,
                        ],
                    ],
                    // ...
                ],
            ],
            'iotTwinMakerConfiguration' => [
                'filters' => [
                    [
                        'filterByComponentType' => [
                            'componentTypeId' => '<string>', // REQUIRED
                        ],
                        'filterByEntity' => [
                            'entityId' => '<string>', // REQUIRED
                        ],
                    ],
                    // ...
                ],
                'workspace' => '<string>', // REQUIRED
            ],
            's3Configuration' => [
                'location' => '<string>', // REQUIRED
            ],
            'type' => 's3|iotsitewise|iottwinmaker', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

description

: Type: string

The metadata transfer job description.

destination

: Required: Yes
: Type: DestinationConfiguration structure

The metadata transfer job destination.

metadataTransferJobId

: Type: string

The metadata transfer job Id.

sources

: Required: Yes
: Type: Array of SourceConfiguration structures

The metadata transfer job sources.

Result Syntax

[
    'arn' => '<string>',
    'creationDateTime' => <DateTime>,
    'metadataTransferJobId' => '<string>',
    'status' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE|SYNC_INITIALIZING_ERROR|SYNC_CREATING_ERROR|SYNC_PROCESSING_ERROR|SYNC_DELETING_ERROR|PROCESSING_ERROR|COMPOSITE_COMPONENT_FAILURE',
            'message' => '<string>',
        ],
        'queuedPosition' => <integer>,
        'state' => 'VALIDATING|PENDING|RUNNING|CANCELLING|ERROR|COMPLETED|CANCELLED',
    ],
]

Result Details

Members

arn

: Required: Yes
: Type: string

The metadata transfer job ARN.

creationDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The The metadata transfer job creation DateTime property.

metadataTransferJobId

: Required: Yes
: Type: string

The metadata transfer job Id.

status

: Required: Yes
: Type: MetadataTransferJobStatus structure

The metadata transfer job response status.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ConflictException:: A conflict occurred.
ServiceQuotaExceededException:: The service quota was exceeded.

CreateScene

$result = $client->createScene([/* ... */]);
$promise = $client->createSceneAsync([/* ... */]);

Creates a scene.

Parameter Syntax

$result = $client->createScene([
    'capabilities' => ['<string>', ...],
    'contentLocation' => '<string>', // REQUIRED
    'description' => '<string>',
    'sceneId' => '<string>', // REQUIRED
    'sceneMetadata' => ['<string>', ...],
    'tags' => ['<string>', ...],
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

capabilities

: Type: Array of strings

A list of capabilities that the scene uses to render itself.

contentLocation

: Required: Yes
: Type: string

The relative path that specifies the location of the content definition file.

description

: Type: string

The description for this scene.

sceneId

: Required: Yes
: Type: string

The ID of the scene.

sceneMetadata

: Type: Associative array of custom strings keys (Name) to strings

The request metadata.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

Metadata that you can use to manage the scene.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace that contains the scene.

Result Syntax

[
    'arn' => '<string>',
    'creationDateTime' => <DateTime>,
]

Result Details

Members

arn

: Required: Yes
: Type: string

The ARN of the scene.

creationDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the scene was created.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ConflictException:: A conflict occurred.
ServiceQuotaExceededException:: The service quota was exceeded.

CreateSyncJob

$result = $client->createSyncJob([/* ... */]);
$promise = $client->createSyncJobAsync([/* ... */]);

This action creates a SyncJob.

Parameter Syntax

$result = $client->createSyncJob([
    'syncRole' => '<string>', // REQUIRED
    'syncSource' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

syncRole

: Required: Yes
: Type: string

The SyncJob IAM role. This IAM role is used by the SyncJob to read from the syncSource, and create, update, or delete the corresponding resources.

syncSource

: Required: Yes
: Type: string

The sync source.

Currently the only supported syncSoource is SITEWISE .

tags

: Type: Associative array of custom strings keys (TagKey) to strings

The SyncJob tags.

workspaceId

: Required: Yes
: Type: string

The workspace ID.

Result Syntax

[
    'arn' => '<string>',
    'creationDateTime' => <DateTime>,
    'state' => 'CREATING|INITIALIZING|ACTIVE|DELETING|ERROR',
]

Result Details

Members

arn

: Required: Yes
: Type: string

The SyncJob ARN.

creationDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time for the SyncJob creation.

state

: Required: Yes
: Type: string

The SyncJob response state.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ConflictException:: A conflict occurred.
ServiceQuotaExceededException:: The service quota was exceeded.

CreateWorkspace

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

Creates a workplace.

Parameter Syntax

$result = $client->createWorkspace([
    'description' => '<string>',
    'role' => '<string>',
    's3Location' => '<string>',
    'tags' => ['<string>', ...],
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

description

: Type: string

The description of the workspace.

role

: Type: string

The ARN of the execution role associated with the workspace.

s3Location

: Type: string

The ARN of the S3 bucket where resources associated with the workspace are stored.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

Metadata that you can use to manage the workspace

workspaceId

: Required: Yes
: Type: string

The ID of the workspace.

Result Syntax

[
    'arn' => '<string>',
    'creationDateTime' => <DateTime>,
]

Result Details

Members

arn

: Required: Yes
: Type: string

The ARN of the workspace.

creationDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the workspace was created.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ConflictException:: A conflict occurred.
ServiceQuotaExceededException:: The service quota was exceeded.

DeleteComponentType

$result = $client->deleteComponentType([/* ... */]);
$promise = $client->deleteComponentTypeAsync([/* ... */]);

Deletes a component type.

Parameter Syntax

$result = $client->deleteComponentType([
    'componentTypeId' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

componentTypeId

: Required: Yes
: Type: string

The ID of the component type to delete.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace that contains the component type.

Result Syntax

[
    'state' => 'CREATING|UPDATING|DELETING|ACTIVE|ERROR',
]

Result Details

Members

state

: Required: Yes
: Type: string

The current state of the component type to be deleted.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed

DeleteEntity

$result = $client->deleteEntity([/* ... */]);
$promise = $client->deleteEntityAsync([/* ... */]);

Deletes an entity.

Parameter Syntax

$result = $client->deleteEntity([
    'entityId' => '<string>', // REQUIRED
    'isRecursive' => true || false,
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

entityId

: Required: Yes
: Type: string

The ID of the entity to delete.

isRecursive

: Type: boolean

A Boolean value that specifies whether the operation deletes child entities.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace that contains the entity to delete.

Result Syntax

[
    'state' => 'CREATING|UPDATING|DELETING|ACTIVE|ERROR',
]

Result Details

Members

state

: Required: Yes
: Type: string

The current state of the deleted entity.

Errors

InternalServerException:: An unexpected error has occurred.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ServiceQuotaExceededException:: The service quota was exceeded.

DeleteScene

$result = $client->deleteScene([/* ... */]);
$promise = $client->deleteSceneAsync([/* ... */]);

Deletes a scene.

Parameter Syntax

$result = $client->deleteScene([
    'sceneId' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

sceneId

: Required: Yes
: Type: string

The ID of the scene to delete.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed

DeleteSyncJob

$result = $client->deleteSyncJob([/* ... */]);
$promise = $client->deleteSyncJobAsync([/* ... */]);

Delete the SyncJob.

Parameter Syntax

$result = $client->deleteSyncJob([
    'syncSource' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

syncSource

: Required: Yes
: Type: string

The sync source.

Currently the only supported syncSource is SITEWISE .

workspaceId

: Required: Yes
: Type: string

The workspace ID.

Result Syntax

[
    'state' => 'CREATING|INITIALIZING|ACTIVE|DELETING|ERROR',
]

Result Details

Members

state

: Required: Yes
: Type: string

The SyncJob response state.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ServiceQuotaExceededException:: The service quota was exceeded.

DeleteWorkspace

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

Deletes a workspace.

Parameter Syntax

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

Parameter Details

Members

workspaceId

: Required: Yes
: Type: string

The ID of the workspace to delete.

Result Syntax

[
    'message' => '<string>',
]

Result Details

Members

message

: Type: string

The string that specifies the delete result for the workspace.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed

ExecuteQuery

$result = $client->executeQuery([/* ... */]);
$promise = $client->executeQueryAsync([/* ... */]);

Run queries to access information from your knowledge graph of entities within individual workspaces.

The ExecuteQuery action only works with Amazon Web Services Java SDK2. ExecuteQuery will not work with any Amazon Web Services Java SDK version < 2.x.

Parameter Syntax

$result = $client->executeQuery([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'queryStatement' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results to return at one time. The default is 50.

nextToken

: Type: string

The string that specifies the next page of results.

queryStatement

: Required: Yes
: Type: string

The query statement.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace.

Result Syntax

[
    'columnDescriptions' => [
        [
            'name' => '<string>',
            'type' => 'NODE|EDGE|VALUE',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'rows' => [
        [
            'rowData' => [
                [
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members

columnDescriptions

: Type: Array of ColumnDescription structures

A list of ColumnDescription objects.

nextToken

: Type: string

The string that specifies the next page of results.

rows

: Type: Array of Row structures

Represents a single row in the query results.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
QueryTimeoutException:: The query timeout exception.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ServiceQuotaExceededException:: The service quota was exceeded.

GetComponentType

$result = $client->getComponentType([/* ... */]);
$promise = $client->getComponentTypeAsync([/* ... */]);

Retrieves information about a component type.

Parameter Syntax

$result = $client->getComponentType([
    'componentTypeId' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

componentTypeId

: Required: Yes
: Type: string

The ID of the component type.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace that contains the component type.

Result Syntax

[
    'arn' => '<string>',
    'componentTypeId' => '<string>',
    'componentTypeName' => '<string>',
    'compositeComponentTypes' => [
        '<Name>' => [
            'componentTypeId' => '<string>',
            'isInherited' => true || false,
        ],
        // ...
    ],
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'extendsFrom' => ['<string>', ...],
    'functions' => [
        '<Name>' => [
            'implementedBy' => [
                'isNative' => true || false,
                'lambda' => [
                    'arn' => '<string>',
                ],
            ],
            'isInherited' => true || false,
            'requiredProperties' => ['<string>', ...],
            'scope' => 'ENTITY|WORKSPACE',
        ],
        // ...
    ],
    'isAbstract' => true || false,
    'isSchemaInitialized' => true || false,
    'isSingleton' => true || false,
    'propertyDefinitions' => [
        '<Name>' => [
            'configuration' => ['<string>', ...],
            'dataType' => [
                'allowedValues' => [
                    [
                        'booleanValue' => true || false,
                        'doubleValue' => <float>,
                        'expression' => '<string>',
                        'integerValue' => <integer>,
                        'listValue' => [...], // RECURSIVE
                        'longValue' => <integer>,
                        'mapValue' => [
                            '<String>' => [...], // RECURSIVE
                            // ...
                        ],
                        'relationshipValue' => [
                            'targetComponentName' => '<string>',
                            'targetEntityId' => '<string>',
                        ],
                        'stringValue' => '<string>',
                    ],
                    // ...
                ],
                'nestedType' => [...], // RECURSIVE
                'relationship' => [
                    'relationshipType' => '<string>',
                    'targetComponentTypeId' => '<string>',
                ],
                'type' => 'RELATIONSHIP|STRING|LONG|BOOLEAN|INTEGER|DOUBLE|LIST|MAP',
                'unitOfMeasure' => '<string>',
            ],
            'defaultValue' => [
                'booleanValue' => true || false,
                'doubleValue' => <float>,
                'expression' => '<string>',
                'integerValue' => <integer>,
                'listValue' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'longValue' => <integer>,
                'mapValue' => [
                    '<String>' => [...], // RECURSIVE
                    // ...
                ],
                'relationshipValue' => [
                    'targetComponentName' => '<string>',
                    'targetEntityId' => '<string>',
                ],
                'stringValue' => '<string>',
            ],
            'displayName' => '<string>',
            'isExternalId' => true || false,
            'isFinal' => true || false,
            'isImported' => true || false,
            'isInherited' => true || false,
            'isRequiredInEntity' => true || false,
            'isStoredExternally' => true || false,
            'isTimeSeries' => true || false,
        ],
        // ...
    ],
    'propertyGroups' => [
        '<Name>' => [
            'groupType' => 'TABULAR',
            'isInherited' => true || false,
            'propertyNames' => ['<string>', ...],
        ],
        // ...
    ],
    'status' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE|SYNC_INITIALIZING_ERROR|SYNC_CREATING_ERROR|SYNC_PROCESSING_ERROR|SYNC_DELETING_ERROR|PROCESSING_ERROR|COMPOSITE_COMPONENT_FAILURE',
            'message' => '<string>',
        ],
        'state' => 'CREATING|UPDATING|DELETING|ACTIVE|ERROR',
    ],
    'syncSource' => '<string>',
    'updateDateTime' => <DateTime>,
    'workspaceId' => '<string>',
]

Result Details

Members

arn

: Required: Yes
: Type: string

The ARN of the component type.

componentTypeId

: Required: Yes
: Type: string

The ID of the component type.

componentTypeName

: Type: string

The component type name.

compositeComponentTypes

: Type: Associative array of custom strings keys (Name) to CompositeComponentTypeResponse structures

This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.

creationDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the component type was created.

description

: Type: string

The description of the component type.

extendsFrom

: Type: Array of strings

The name of the parent component type that this component type extends.

functions

: Type: Associative array of custom strings keys (Name) to FunctionResponse structures

An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

isAbstract

: Type: boolean

A Boolean value that specifies whether the component type is abstract.

isSchemaInitialized

: Type: boolean

A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.

isSingleton

: Type: boolean

A Boolean value that specifies whether an entity can have more than one component of this type.

propertyDefinitions

: Type: Associative array of custom strings keys (Name) to PropertyDefinitionResponse structures

An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

propertyGroups

: Type: Associative array of custom strings keys (Name) to PropertyGroupResponse structures

The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

status

: Type: Status structure

The current status of the component type.

syncSource

: Type: string

The syncSource of the SyncJob, if this entity was created by a SyncJob.

updateDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the component was last updated.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace that contains the component type.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed

GetEntity

$result = $client->getEntity([/* ... */]);
$promise = $client->getEntityAsync([/* ... */]);

Retrieves information about an entity.

Parameter Syntax

$result = $client->getEntity([
    'entityId' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

entityId

: Required: Yes
: Type: string

The ID of the entity.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace.

Result Syntax

[
    'areAllComponentsReturned' => true || false,
    'arn' => '<string>',
    'components' => [
        '<Name>' => [
            'areAllCompositeComponentsReturned' => true || false,
            'areAllPropertiesReturned' => true || false,
            'componentName' => '<string>',
            'componentTypeId' => '<string>',
            'compositeComponents' => [
                '<Name>' => [
                    'componentName' => '<string>',
                    'componentPath' => '<string>',
                    'componentTypeId' => '<string>',
                    'definedIn' => '<string>',
                    'description' => '<string>',
                    'propertyGroups' => [
                        '<Name>' => [
                            'groupType' => 'TABULAR',
                            'isInherited' => true || false,
                            'propertyNames' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'status' => [
                        'error' => [
                            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE|SYNC_INITIALIZING_ERROR|SYNC_CREATING_ERROR|SYNC_PROCESSING_ERROR|SYNC_DELETING_ERROR|PROCESSING_ERROR|COMPOSITE_COMPONENT_FAILURE',
                            'message' => '<string>',
                        ],
                        'state' => 'CREATING|UPDATING|DELETING|ACTIVE|ERROR',
                    ],
                    'syncSource' => '<string>',
                ],
                // ...
            ],
            'definedIn' => '<string>',
            'description' => '<string>',
            'properties' => [
                '<Name>' => [
                    'areAllPropertyValuesReturned' => true || false,
                    'definition' => [
                        'configuration' => ['<string>', ...],
                        'dataType' => [
                            'allowedValues' => [
                                [
                                    'booleanValue' => true || false,
                                    'doubleValue' => <float>,
                                    'expression' => '<string>',
                                    'integerValue' => <integer>,
                                    'listValue' => [...], // RECURSIVE
                                    'longValue' => <integer>,
                                    'mapValue' => [
                                        '<String>' => [...], // RECURSIVE
                                        // ...
                                    ],
                                    'relationshipValue' => [
                                        'targetComponentName' => '<string>',
                                        'targetEntityId' => '<string>',
                                    ],
                                    'stringValue' => '<string>',
                                ],
                                // ...
                            ],
                            'nestedType' => [...], // RECURSIVE
                            'relationship' => [
                                'relationshipType' => '<string>',
                                'targetComponentTypeId' => '<string>',
                            ],
                            'type' => 'RELATIONSHIP|STRING|LONG|BOOLEAN|INTEGER|DOUBLE|LIST|MAP',
                            'unitOfMeasure' => '<string>',
                        ],
                        'defaultValue' => [
                            'booleanValue' => true || false,
                            'doubleValue' => <float>,
                            'expression' => '<string>',
                            'integerValue' => <integer>,
                            'listValue' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'longValue' => <integer>,
                            'mapValue' => [
                                '<String>' => [...], // RECURSIVE
                                // ...
                            ],
                            'relationshipValue' => [
                                'targetComponentName' => '<string>',
                                'targetEntityId' => '<string>',
                            ],
                            'stringValue' => '<string>',
                        ],
                        'displayName' => '<string>',
                        'isExternalId' => true || false,
                        'isFinal' => true || false,
                        'isImported' => true || false,
                        'isInherited' => true || false,
                        'isRequiredInEntity' => true || false,
                        'isStoredExternally' => true || false,
                        'isTimeSeries' => true || false,
                    ],
                    'value' => [
                        'booleanValue' => true || false,
                        'doubleValue' => <float>,
                        'expression' => '<string>',
                        'integerValue' => <integer>,
                        'listValue' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'longValue' => <integer>,
                        'mapValue' => [
                            '<String>' => [...], // RECURSIVE
                            // ...
                        ],
                        'relationshipValue' => [
                            'targetComponentName' => '<string>',
                            'targetEntityId' => '<string>',
                        ],
                        'stringValue' => '<string>',
                    ],
                ],
                // ...
            ],
            'propertyGroups' => [
                '<Name>' => [
                    'groupType' => 'TABULAR',
                    'isInherited' => true || false,
                    'propertyNames' => ['<string>', ...],
                ],
                // ...
            ],
            'status' => [
                'error' => [
                    'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE|SYNC_INITIALIZING_ERROR|SYNC_CREATING_ERROR|SYNC_PROCESSING_ERROR|SYNC_DELETING_ERROR|PROCESSING_ERROR|COMPOSITE_COMPONENT_FAILURE',
                    'message' => '<string>',
                ],
                'state' => 'CREATING|UPDATING|DELETING|ACTIVE|ERROR',
            ],
            'syncSource' => '<string>',
        ],
        // ...
    ],
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'entityId' => '<string>',
    'entityName' => '<string>',
    'hasChildEntities' => true || false,
    'parentEntityId' => '<string>',
    'status' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE|SYNC_INITIALIZING_ERROR|SYNC_CREATING_ERROR|SYNC_PROCESSING_ERROR|SYNC_DELETING_ERROR|PROCESSING_ERROR|COMPOSITE_COMPONENT_FAILURE',
            'message' => '<string>',
        ],
        'state' => 'CREATING|UPDATING|DELETING|ACTIVE|ERROR',
    ],
    'syncSource' => '<string>',
    'updateDateTime' => <DateTime>,
    'workspaceId' => '<string>',
]

Result Details

Members

areAllComponentsReturned

: Type: boolean

This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.

arn

: Required: Yes
: Type: string

The ARN of the entity.

components

: Type: Associative array of custom strings keys (Name) to ComponentResponse structures

An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

creationDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the entity was created.

description

: Type: string

The description of the entity.

entityId

: Required: Yes
: Type: string

The ID of the entity.

entityName

: Required: Yes
: Type: string

The name of the entity.

hasChildEntities

: Required: Yes
: Type: boolean

A Boolean value that specifies whether the entity has associated child entities.

parentEntityId

: Required: Yes
: Type: string

The ID of the parent entity for this entity.

status

: Required: Yes
: Type: Status structure

The current status of the entity.

syncSource

: Type: string

The syncSource of the sync job, if this entity was created by a sync job.

updateDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the entity was last updated.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace.

Errors

InternalServerException:: An unexpected error has occurred.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ServiceQuotaExceededException:: The service quota was exceeded.

GetMetadataTransferJob

$result = $client->getMetadataTransferJob([/* ... */]);
$promise = $client->getMetadataTransferJobAsync([/* ... */]);

Gets a nmetadata transfer job.

Parameter Syntax

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

Parameter Details

Members

metadataTransferJobId

: Required: Yes
: Type: string

The metadata transfer job Id.

Result Syntax

[
    'arn' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'destination' => [
        'iotTwinMakerConfiguration' => [
            'workspace' => '<string>',
        ],
        's3Configuration' => [
            'location' => '<string>',
        ],
        'type' => 's3|iotsitewise|iottwinmaker',
    ],
    'metadataTransferJobId' => '<string>',
    'metadataTransferJobRole' => '<string>',
    'progress' => [
        'failedCount' => <integer>,
        'skippedCount' => <integer>,
        'succeededCount' => <integer>,
        'totalCount' => <integer>,
    ],
    'reportUrl' => '<string>',
    'sources' => [
        [
            'iotSiteWiseConfiguration' => [
                'filters' => [
                    [
                        'filterByAsset' => [
                            'assetExternalId' => '<string>',
                            'assetId' => '<string>',
                            'includeAssetModel' => true || false,
                            'includeOffspring' => true || false,
                        ],
                        'filterByAssetModel' => [
                            'assetModelExternalId' => '<string>',
                            'assetModelId' => '<string>',
                            'includeAssets' => true || false,
                            'includeOffspring' => true || false,
                        ],
                    ],
                    // ...
                ],
            ],
            'iotTwinMakerConfiguration' => [
                'filters' => [
                    [
                        'filterByComponentType' => [
                            'componentTypeId' => '<string>',
                        ],
                        'filterByEntity' => [
                            'entityId' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'workspace' => '<string>',
            ],
            's3Configuration' => [
                'location' => '<string>',
            ],
            'type' => 's3|iotsitewise|iottwinmaker',
        ],
        // ...
    ],
    'status' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE|SYNC_INITIALIZING_ERROR|SYNC_CREATING_ERROR|SYNC_PROCESSING_ERROR|SYNC_DELETING_ERROR|PROCESSING_ERROR|COMPOSITE_COMPONENT_FAILURE',
            'message' => '<string>',
        ],
        'queuedPosition' => <integer>,
        'state' => 'VALIDATING|PENDING|RUNNING|CANCELLING|ERROR|COMPLETED|CANCELLED',
    ],
    'updateDateTime' => <DateTime>,
]

Result Details

Members

arn

: Required: Yes
: Type: string

The metadata transfer job ARN.

creationDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The metadata transfer job's creation DateTime property.

description

: Type: string

The metadata transfer job description.

destination

: Required: Yes
: Type: DestinationConfiguration structure

The metadata transfer job's destination.

metadataTransferJobId

: Required: Yes
: Type: string

The metadata transfer job Id.

metadataTransferJobRole

: Required: Yes
: Type: string

The metadata transfer job's role.

progress

: Type: MetadataTransferJobProgress structure

The metadata transfer job's progress.

reportUrl

: Type: string

The metadata transfer job's report URL.

sources

: Required: Yes
: Type: Array of SourceConfiguration structures

The metadata transfer job's sources.

status

: Required: Yes
: Type: MetadataTransferJobStatus structure

The metadata transfer job's status.

updateDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The metadata transfer job's update DateTime property.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed

GetPricingPlan

$result = $client->getPricingPlan([/* ... */]);
$promise = $client->getPricingPlanAsync([/* ... */]);

Gets the pricing plan.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[
    'currentPricingPlan' => [
        'billableEntityCount' => <integer>,
        'bundleInformation' => [
            'bundleNames' => ['<string>', ...],
            'pricingTier' => 'TIER_1|TIER_2|TIER_3|TIER_4',
        ],
        'effectiveDateTime' => <DateTime>,
        'pricingMode' => 'BASIC|STANDARD|TIERED_BUNDLE',
        'updateDateTime' => <DateTime>,
        'updateReason' => 'DEFAULT|PRICING_TIER_UPDATE|ENTITY_COUNT_UPDATE|PRICING_MODE_UPDATE|OVERWRITTEN',
    ],
    'pendingPricingPlan' => [
        'billableEntityCount' => <integer>,
        'bundleInformation' => [
            'bundleNames' => ['<string>', ...],
            'pricingTier' => 'TIER_1|TIER_2|TIER_3|TIER_4',
        ],
        'effectiveDateTime' => <DateTime>,
        'pricingMode' => 'BASIC|STANDARD|TIERED_BUNDLE',
        'updateDateTime' => <DateTime>,
        'updateReason' => 'DEFAULT|PRICING_TIER_UPDATE|ENTITY_COUNT_UPDATE|PRICING_MODE_UPDATE|OVERWRITTEN',
    ],
]

Result Details

Members

currentPricingPlan

: Required: Yes
: Type: PricingPlan structure

The chosen pricing plan for the current billing cycle.

pendingPricingPlan

: Type: PricingPlan structure

The pending pricing plan.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed

GetPropertyValue

$result = $client->getPropertyValue([/* ... */]);
$promise = $client->getPropertyValueAsync([/* ... */]);

Gets the property values for a component, component type, entity, or workspace.

You must specify a value for either componentName, componentTypeId, entityId, or workspaceId.

Parameter Syntax

$result = $client->getPropertyValue([
    'componentName' => '<string>',
    'componentPath' => '<string>',
    'componentTypeId' => '<string>',
    'entityId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'propertyGroupName' => '<string>',
    'selectedProperties' => ['<string>', ...], // REQUIRED
    'tabularConditions' => [
        'orderBy' => [
            [
                'order' => 'ASCENDING|DESCENDING',
                'propertyName' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'propertyFilters' => [
            [
                'operator' => '<string>',
                'propertyName' => '<string>',
                'value' => [
                    'booleanValue' => true || false,
                    'doubleValue' => <float>,
                    'expression' => '<string>',
                    'integerValue' => <integer>,
                    'listValue' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'longValue' => <integer>,
                    'mapValue' => [
                        '<String>' => [...], // RECURSIVE
                        // ...
                    ],
                    'relationshipValue' => [
                        'targetComponentName' => '<string>',
                        'targetEntityId' => '<string>',
                    ],
                    'stringValue' => '<string>',
                ],
            ],
            // ...
        ],
    ],
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

componentName

: Type: string

The name of the component whose property values the operation returns.

componentPath

: Type: string

This string specifies the path to the composite component, starting from the top-level component.

componentTypeId

: Type: string

The ID of the component type whose property values the operation returns.

entityId

: Type: string

The ID of the entity whose property values the operation returns.

maxResults

: Type: int

The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken

: Type: string

The string that specifies the next page of results.

propertyGroupName

: Type: string

The property group name.

selectedProperties

: Required: Yes
: Type: Array of strings

The properties whose values the operation returns.

tabularConditions

: Type: TabularConditions structure

The tabular conditions.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace whose values the operation returns.

Result Syntax

[
    'nextToken' => '<string>',
    'propertyValues' => [
        '<Name>' => [
            'propertyReference' => [
                'componentName' => '<string>',
                'componentPath' => '<string>',
                'entityId' => '<string>',
                'externalIdProperty' => ['<string>', ...],
                'propertyName' => '<string>',
            ],
            'propertyValue' => [
                'booleanValue' => true || false,
                'doubleValue' => <float>,
                'expression' => '<string>',
                'integerValue' => <integer>,
                'listValue' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'longValue' => <integer>,
                'mapValue' => [
                    '<String>' => [...], // RECURSIVE
                    // ...
                ],
                'relationshipValue' => [
                    'targetComponentName' => '<string>',
                    'targetEntityId' => '<string>',
                ],
                'stringValue' => '<string>',
            ],
        ],
        // ...
    ],
    'tabularPropertyValues' => [
        [
            [
                '<Name>' => [
                    'booleanValue' => true || false,
                    'doubleValue' => <float>,
                    'expression' => '<string>',
                    'integerValue' => <integer>,
                    'listValue' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'longValue' => <integer>,
                    'mapValue' => [
                        '<String>' => [...], // RECURSIVE
                        // ...
                    ],
                    'relationshipValue' => [
                        'targetComponentName' => '<string>',
                        'targetEntityId' => '<string>',
                    ],
                    'stringValue' => '<string>',
                ],
                // ...
            ],
            // ...
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

The string that specifies the next page of results.

propertyValues

: Type: Associative array of custom strings keys (Name) to PropertyLatestValue structures

An object that maps strings to the properties and latest property values in the response. Each string in the mapping must be unique to this object.

tabularPropertyValues

: Type: Array of lists

A table of property values.

Errors

InternalServerException:: An unexpected error has occurred.
ConnectorFailureException:: The connector failed.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ConnectorTimeoutException:: The connector timed out.

GetPropertyValueHistory

$result = $client->getPropertyValueHistory([/* ... */]);
$promise = $client->getPropertyValueHistoryAsync([/* ... */]);

Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.

You must specify a value for workspaceId. For entity-specific queries, specify values for componentName and entityId. For cross-entity quries, specify a value for componentTypeId.

Parameter Syntax

$result = $client->getPropertyValueHistory([
    'componentName' => '<string>',
    'componentPath' => '<string>',
    'componentTypeId' => '<string>',
    'endDateTime' => <integer || string || DateTime>,
    'endTime' => '<string>',
    'entityId' => '<string>',
    'interpolation' => [
        'interpolationType' => 'LINEAR',
        'intervalInSeconds' => <integer>,
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'orderByTime' => 'ASCENDING|DESCENDING',
    'propertyFilters' => [
        [
            'operator' => '<string>',
            'propertyName' => '<string>',
            'value' => [
                'booleanValue' => true || false,
                'doubleValue' => <float>,
                'expression' => '<string>',
                'integerValue' => <integer>,
                'listValue' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'longValue' => <integer>,
                'mapValue' => [
                    '<String>' => [...], // RECURSIVE
                    // ...
                ],
                'relationshipValue' => [
                    'targetComponentName' => '<string>',
                    'targetEntityId' => '<string>',
                ],
                'stringValue' => '<string>',
            ],
        ],
        // ...
    ],
    'selectedProperties' => ['<string>', ...], // REQUIRED
    'startDateTime' => <integer || string || DateTime>,
    'startTime' => '<string>',
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

componentName

: Type: string

The name of the component.

componentPath

: Type: string

This string specifies the path to the composite component, starting from the top-level component.

componentTypeId

: Type: string

The ID of the component type.

endDateTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time of the latest property value to return.

endTime

: Type: string

The ISO8601 DateTime of the latest property value to return.

For more information about the ISO8601 DateTime format, see the data type PropertyValue.

entityId

: Type: string

The ID of the entity.

interpolation

: Type: InterpolationParameters structure

An object that specifies the interpolation type and the interval over which to interpolate data.

maxResults

: Type: int

The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken

: Type: string

The string that specifies the next page of results.

orderByTime

: Type: string

The time direction to use in the result order.

propertyFilters

: Type: Array of PropertyFilter structures

A list of objects that filter the property value history request.

selectedProperties

: Required: Yes
: Type: Array of strings

A list of properties whose value histories the request retrieves.

startDateTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time of the earliest property value to return.

startTime

: Type: string

The ISO8601 DateTime of the earliest property value to return.

For more information about the ISO8601 DateTime format, see the data type PropertyValue.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace.

Result Syntax

[
    'nextToken' => '<string>',
    'propertyValues' => [
        [
            'entityPropertyReference' => [
                'componentName' => '<string>',
                'componentPath' => '<string>',
                'entityId' => '<string>',
                'externalIdProperty' => ['<string>', ...],
                'propertyName' => '<string>',
            ],
            'values' => [
                [
                    'time' => '<string>',
                    'timestamp' => <DateTime>,
                    'value' => [
                        'booleanValue' => true || false,
                        'doubleValue' => <float>,
                        'expression' => '<string>',
                        'integerValue' => <integer>,
                        'listValue' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'longValue' => <integer>,
                        'mapValue' => [
                            '<String>' => [...], // RECURSIVE
                            // ...
                        ],
                        'relationshipValue' => [
                            'targetComponentName' => '<string>',
                            'targetEntityId' => '<string>',
                        ],
                        'stringValue' => '<string>',
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

The string that specifies the next page of results.

propertyValues

: Required: Yes
: Type: Array of PropertyValueHistory structures

An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

Errors

InternalServerException:: An unexpected error has occurred.
ConnectorFailureException:: The connector failed.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ConnectorTimeoutException:: The connector timed out.

GetScene

$result = $client->getScene([/* ... */]);
$promise = $client->getSceneAsync([/* ... */]);

Retrieves information about a scene.

Parameter Syntax

$result = $client->getScene([
    'sceneId' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

sceneId

: Required: Yes
: Type: string

The ID of the scene.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace that contains the scene.

Result Syntax

[
    'arn' => '<string>',
    'capabilities' => ['<string>', ...],
    'contentLocation' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'error' => [
        'code' => 'MATTERPORT_ERROR',
        'message' => '<string>',
    ],
    'generatedSceneMetadata' => ['<string>', ...],
    'sceneId' => '<string>',
    'sceneMetadata' => ['<string>', ...],
    'updateDateTime' => <DateTime>,
    'workspaceId' => '<string>',
]

Result Details

Members

arn

: Required: Yes
: Type: string

The ARN of the scene.

capabilities

: Type: Array of strings

A list of capabilities that the scene uses to render.

contentLocation

: Required: Yes
: Type: string

The relative path that specifies the location of the content definition file.

creationDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the scene was created.

description

: Type: string

The description of the scene.

error

: Type: SceneError structure

The SceneResponse error.

generatedSceneMetadata

: Type: Associative array of custom strings keys (Name) to strings

The generated scene metadata.

sceneId

: Required: Yes
: Type: string

The ID of the scene.

sceneMetadata

: Type: Associative array of custom strings keys (Name) to strings

The response metadata.

updateDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the scene was last updated.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace that contains the scene.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed

GetSyncJob

$result = $client->getSyncJob([/* ... */]);
$promise = $client->getSyncJobAsync([/* ... */]);

Gets the SyncJob.

Parameter Syntax

$result = $client->getSyncJob([
    'syncSource' => '<string>', // REQUIRED
    'workspaceId' => '<string>',
]);

Parameter Details

Members

syncSource

: Required: Yes
: Type: string

The sync source.

Currently the only supported syncSource is SITEWISE .

workspaceId

: Type: string

The workspace ID.

Result Syntax

[
    'arn' => '<string>',
    'creationDateTime' => <DateTime>,
    'status' => [
        'error' => [
            'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE|SYNC_INITIALIZING_ERROR|SYNC_CREATING_ERROR|SYNC_PROCESSING_ERROR|SYNC_DELETING_ERROR|PROCESSING_ERROR|COMPOSITE_COMPONENT_FAILURE',
            'message' => '<string>',
        ],
        'state' => 'CREATING|INITIALIZING|ACTIVE|DELETING|ERROR',
    ],
    'syncRole' => '<string>',
    'syncSource' => '<string>',
    'updateDateTime' => <DateTime>,
    'workspaceId' => '<string>',
]

Result Details

Members

arn

: Required: Yes
: Type: string

The sync job ARN.

creationDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date and time.

status

: Required: Yes
: Type: SyncJobStatus structure

The SyncJob response status.

syncRole

: Required: Yes
: Type: string

The sync IAM role.

syncSource

: Required: Yes
: Type: string

The sync soucre.

Currently the only supported syncSource is SITEWISE .

updateDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The update date and time.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace that contains the sync job.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ServiceQuotaExceededException:: The service quota was exceeded.

GetWorkspace

$result = $client->getWorkspace([/* ... */]);
$promise = $client->getWorkspaceAsync([/* ... */]);

Retrieves information about a workspace.

Parameter Syntax

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

Parameter Details

Members

workspaceId

: Required: Yes
: Type: string

The ID of the workspace.

Result Syntax

[
    'arn' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'linkedServices' => ['<string>', ...],
    'role' => '<string>',
    's3Location' => '<string>',
    'updateDateTime' => <DateTime>,
    'workspaceId' => '<string>',
]

Result Details

Members

arn

: Required: Yes
: Type: string

The ARN of the workspace.

creationDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the workspace was created.

description

: Type: string

The description of the workspace.

linkedServices

: Type: Array of strings

A list of services that are linked to the workspace.

role

: Type: string

The ARN of the execution role associated with the workspace.

s3Location

: Type: string

The ARN of the S3 bucket where resources associated with the workspace are stored.

updateDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the workspace was last updated.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace.

Errors

InternalServerException:: An unexpected error has occurred.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ServiceQuotaExceededException:: The service quota was exceeded.

ListComponentTypes

$result = $client->listComponentTypes([/* ... */]);
$promise = $client->listComponentTypesAsync([/* ... */]);

Lists all component types in a workspace.

Parameter Syntax

$result = $client->listComponentTypes([
    'filters' => [
        [
            'extendsFrom' => '<string>',
            'isAbstract' => true || false,
            'namespace' => '<string>',
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

filters

: Type: Array of ListComponentTypesFilter structures

A list of objects that filter the request.

maxResults

: Type: int

The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken

: Type: string

The string that specifies the next page of results.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace.

Result Syntax

[
    'componentTypeSummaries' => [
        [
            'arn' => '<string>',
            'componentTypeId' => '<string>',
            'componentTypeName' => '<string>',
            'creationDateTime' => <DateTime>,
            'description' => '<string>',
            'status' => [
                'error' => [
                    'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE|SYNC_INITIALIZING_ERROR|SYNC_CREATING_ERROR|SYNC_PROCESSING_ERROR|SYNC_DELETING_ERROR|PROCESSING_ERROR|COMPOSITE_COMPONENT_FAILURE',
                    'message' => '<string>',
                ],
                'state' => 'CREATING|UPDATING|DELETING|ACTIVE|ERROR',
            ],
            'updateDateTime' => <DateTime>,
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'workspaceId' => '<string>',
]

Result Details

Members

componentTypeSummaries

: Required: Yes
: Type: Array of ComponentTypeSummary structures

A list of objects that contain information about the component types.

maxResults

: Type: int

Specifies the maximum number of results to display.

nextToken

: Type: string

The string that specifies the next page of results.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed

ListComponents

$result = $client->listComponents([/* ... */]);
$promise = $client->listComponentsAsync([/* ... */]);

This API lists the components of an entity.

Parameter Syntax

$result = $client->listComponents([
    'componentPath' => '<string>',
    'entityId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

componentPath

: Type: string

This string specifies the path to the composite component, starting from the top-level component.

entityId

: Required: Yes
: Type: string

The ID for the entity whose metadata (component/properties) is returned by the operation.

maxResults

: Type: int

The maximum number of results returned at one time. The default is 25.

nextToken

: Type: string

The string that specifies the next page of results.

workspaceId

: Required: Yes
: Type: string

The workspace ID.

Result Syntax

[
    'componentSummaries' => [
        [
            'componentName' => '<string>',
            'componentPath' => '<string>',
            'componentTypeId' => '<string>',
            'definedIn' => '<string>',
            'description' => '<string>',
            'propertyGroups' => [
                '<Name>' => [
                    'groupType' => 'TABULAR',
                    'isInherited' => true || false,
                    'propertyNames' => ['<string>', ...],
                ],
                // ...
            ],
            'status' => [
                'error' => [
                    'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE|SYNC_INITIALIZING_ERROR|SYNC_CREATING_ERROR|SYNC_PROCESSING_ERROR|SYNC_DELETING_ERROR|PROCESSING_ERROR|COMPOSITE_COMPONENT_FAILURE',
                    'message' => '<string>',
                ],
                'state' => 'CREATING|UPDATING|DELETING|ACTIVE|ERROR',
            ],
            'syncSource' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

componentSummaries

: Required: Yes
: Type: Array of ComponentSummary structures

A list of objects that contain information about the components.

nextToken

: Type: string

The string that specifies the next page of component results.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed

ListEntities

$result = $client->listEntities([/* ... */]);
$promise = $client->listEntitiesAsync([/* ... */]);

Lists all entities in a workspace.

Parameter Syntax

$result = $client->listEntities([
    'filters' => [
        [
            'componentTypeId' => '<string>',
            'externalId' => '<string>',
            'parentEntityId' => '<string>',
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

filters

: Type: Array of ListEntitiesFilter structures

A list of objects that filter the request.

Only one object is accepted as a valid input.

maxResults

: Type: int

The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken

: Type: string

The string that specifies the next page of results.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace.

Result Syntax

[
    'entitySummaries' => [
        [
            'arn' => '<string>',
            'creationDateTime' => <DateTime>,
            'description' => '<string>',
            'entityId' => '<string>',
            'entityName' => '<string>',
            'hasChildEntities' => true || false,
            'parentEntityId' => '<string>',
            'status' => [
                'error' => [
                    'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE|SYNC_INITIALIZING_ERROR|SYNC_CREATING_ERROR|SYNC_PROCESSING_ERROR|SYNC_DELETING_ERROR|PROCESSING_ERROR|COMPOSITE_COMPONENT_FAILURE',
                    'message' => '<string>',
                ],
                'state' => 'CREATING|UPDATING|DELETING|ACTIVE|ERROR',
            ],
            'updateDateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

entitySummaries

: Type: Array of EntitySummary structures

A list of objects that contain information about the entities.

nextToken

: Type: string

The string that specifies the next page of results.

Errors

InternalServerException:: An unexpected error has occurred.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ServiceQuotaExceededException:: The service quota was exceeded.

ListMetadataTransferJobs

$result = $client->listMetadataTransferJobs([/* ... */]);
$promise = $client->listMetadataTransferJobsAsync([/* ... */]);

Lists the metadata transfer jobs.

Parameter Syntax

$result = $client->listMetadataTransferJobs([
    'destinationType' => 's3|iotsitewise|iottwinmaker', // REQUIRED
    'filters' => [
        [
            'state' => 'VALIDATING|PENDING|RUNNING|CANCELLING|ERROR|COMPLETED|CANCELLED',
            'workspaceId' => '<string>',
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sourceType' => 's3|iotsitewise|iottwinmaker', // REQUIRED
]);

Parameter Details

Members

destinationType

: Required: Yes
: Type: string

The metadata transfer job's destination type.

filters

: Type: Array of ListMetadataTransferJobsFilter structures

An object that filters metadata transfer jobs.

maxResults

: Type: int

The maximum number of results to return at one time.

nextToken

: Type: string

The string that specifies the next page of results.

sourceType

: Required: Yes
: Type: string

The metadata transfer job's source type.

Result Syntax

[
    'metadataTransferJobSummaries' => [
        [
            'arn' => '<string>',
            'creationDateTime' => <DateTime>,
            'metadataTransferJobId' => '<string>',
            'progress' => [
                'failedCount' => <integer>,
                'skippedCount' => <integer>,
                'succeededCount' => <integer>,
                'totalCount' => <integer>,
            ],
            'status' => [
                'error' => [
                    'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE|SYNC_INITIALIZING_ERROR|SYNC_CREATING_ERROR|SYNC_PROCESSING_ERROR|SYNC_DELETING_ERROR|PROCESSING_ERROR|COMPOSITE_COMPONENT_FAILURE',
                    'message' => '<string>',
                ],
                'queuedPosition' => <integer>,
                'state' => 'VALIDATING|PENDING|RUNNING|CANCELLING|ERROR|COMPLETED|CANCELLED',
            ],
            'updateDateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

metadataTransferJobSummaries

: Required: Yes
: Type: Array of MetadataTransferJobSummary structures

The metadata transfer job summaries.

nextToken

: Type: string

The string that specifies the next page of results.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed

ListProperties

$result = $client->listProperties([/* ... */]);
$promise = $client->listPropertiesAsync([/* ... */]);

This API lists the properties of a component.

Parameter Syntax

$result = $client->listProperties([
    'componentName' => '<string>',
    'componentPath' => '<string>',
    'entityId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

componentName

: Type: string

The name of the component whose properties are returned by the operation.

componentPath

: Type: string

This string specifies the path to the composite component, starting from the top-level component.

entityId

: Required: Yes
: Type: string

The ID for the entity whose metadata (component/properties) is returned by the operation.

maxResults

: Type: int

The maximum number of results returned at one time. The default is 25.

nextToken

: Type: string

The string that specifies the next page of results.

workspaceId

: Required: Yes
: Type: string

The workspace ID.

Result Syntax

[
    'nextToken' => '<string>',
    'propertySummaries' => [
        [
            'areAllPropertyValuesReturned' => true || false,
            'definition' => [
                'configuration' => ['<string>', ...],
                'dataType' => [
                    'allowedValues' => [
                        [
                            'booleanValue' => true || false,
                            'doubleValue' => <float>,
                            'expression' => '<string>',
                            'integerValue' => <integer>,
                            'listValue' => [...], // RECURSIVE
                            'longValue' => <integer>,
                            'mapValue' => [
                                '<String>' => [...], // RECURSIVE
                                // ...
                            ],
                            'relationshipValue' => [
                                'targetComponentName' => '<string>',
                                'targetEntityId' => '<string>',
                            ],
                            'stringValue' => '<string>',
                        ],
                        // ...
                    ],
                    'nestedType' => [...], // RECURSIVE
                    'relationship' => [
                        'relationshipType' => '<string>',
                        'targetComponentTypeId' => '<string>',
                    ],
                    'type' => 'RELATIONSHIP|STRING|LONG|BOOLEAN|INTEGER|DOUBLE|LIST|MAP',
                    'unitOfMeasure' => '<string>',
                ],
                'defaultValue' => [
                    'booleanValue' => true || false,
                    'doubleValue' => <float>,
                    'expression' => '<string>',
                    'integerValue' => <integer>,
                    'listValue' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'longValue' => <integer>,
                    'mapValue' => [
                        '<String>' => [...], // RECURSIVE
                        // ...
                    ],
                    'relationshipValue' => [
                        'targetComponentName' => '<string>',
                        'targetEntityId' => '<string>',
                    ],
                    'stringValue' => '<string>',
                ],
                'displayName' => '<string>',
                'isExternalId' => true || false,
                'isFinal' => true || false,
                'isImported' => true || false,
                'isInherited' => true || false,
                'isRequiredInEntity' => true || false,
                'isStoredExternally' => true || false,
                'isTimeSeries' => true || false,
            ],
            'propertyName' => '<string>',
            'value' => [
                'booleanValue' => true || false,
                'doubleValue' => <float>,
                'expression' => '<string>',
                'integerValue' => <integer>,
                'listValue' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'longValue' => <integer>,
                'mapValue' => [
                    '<String>' => [...], // RECURSIVE
                    // ...
                ],
                'relationshipValue' => [
                    'targetComponentName' => '<string>',
                    'targetEntityId' => '<string>',
                ],
                'stringValue' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

The string that specifies the next page of property results.

propertySummaries

: Required: Yes
: Type: Array of PropertySummary structures

A list of objects that contain information about the properties.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed

ListScenes

$result = $client->listScenes([/* ... */]);
$promise = $client->listScenesAsync([/* ... */]);

Lists all scenes in a workspace.

Parameter Syntax

$result = $client->listScenes([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

maxResults

: Type: int

Specifies the maximum number of results to display.

nextToken

: Type: string

The string that specifies the next page of results.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace that contains the scenes.

Result Syntax

[
    'nextToken' => '<string>',
    'sceneSummaries' => [
        [
            'arn' => '<string>',
            'contentLocation' => '<string>',
            'creationDateTime' => <DateTime>,
            'description' => '<string>',
            'sceneId' => '<string>',
            'updateDateTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

The string that specifies the next page of results.

sceneSummaries

: Type: Array of SceneSummary structures

A list of objects that contain information about the scenes.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed

ListSyncJobs

$result = $client->listSyncJobs([/* ... */]);
$promise = $client->listSyncJobsAsync([/* ... */]);

List all SyncJobs.

Parameter Syntax

$result = $client->listSyncJobs([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results to return at one time. The default is 50.

Valid Range: Minimum value of 0. Maximum value of 200.

nextToken

: Type: string

The string that specifies the next page of results.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace that contains the sync job.

Result Syntax

[
    'nextToken' => '<string>',
    'syncJobSummaries' => [
        [
            'arn' => '<string>',
            'creationDateTime' => <DateTime>,
            'status' => [
                'error' => [
                    'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE|SYNC_INITIALIZING_ERROR|SYNC_CREATING_ERROR|SYNC_PROCESSING_ERROR|SYNC_DELETING_ERROR|PROCESSING_ERROR|COMPOSITE_COMPONENT_FAILURE',
                    'message' => '<string>',
                ],
                'state' => 'CREATING|INITIALIZING|ACTIVE|DELETING|ERROR',
            ],
            'syncSource' => '<string>',
            'updateDateTime' => <DateTime>,
            'workspaceId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

The string that specifies the next page of results.

syncJobSummaries

: Type: Array of SyncJobSummary structures

The listed SyncJob summaries.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ServiceQuotaExceededException:: The service quota was exceeded.

ListSyncResources

$result = $client->listSyncResources([/* ... */]);
$promise = $client->listSyncResourcesAsync([/* ... */]);

Lists the sync resources.

Parameter Syntax

$result = $client->listSyncResources([
    'filters' => [
        [
            'externalId' => '<string>',
            'resourceId' => '<string>',
            'resourceType' => 'ENTITY|COMPONENT_TYPE',
            'state' => 'INITIALIZING|PROCESSING|DELETED|IN_SYNC|ERROR',
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'syncSource' => '<string>', // REQUIRED
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

filters

: Type: Array of SyncResourceFilter structures

A list of objects that filter the request.

The following filter combinations are supported:

Filter with state
Filter with ResourceType and ResourceId
Filter with ResourceType and ExternalId

maxResults

: Type: int

The maximum number of results to return at one time. The default is 50.

Valid Range: Minimum value of 0. Maximum value of 200.

nextToken

: Type: string

The string that specifies the next page of results.

syncSource

: Required: Yes
: Type: string

The sync source.

Currently the only supported syncSource is SITEWISE .

workspaceId

: Required: Yes
: Type: string

The ID of the workspace that contains the sync job.

Result Syntax

[
    'nextToken' => '<string>',
    'syncResources' => [
        [
            'externalId' => '<string>',
            'resourceId' => '<string>',
            'resourceType' => 'ENTITY|COMPONENT_TYPE',
            'status' => [
                'error' => [
                    'code' => 'VALIDATION_ERROR|INTERNAL_FAILURE|SYNC_INITIALIZING_ERROR|SYNC_CREATING_ERROR|SYNC_PROCESSING_ERROR|SYNC_DELETING_ERROR|PROCESSING_ERROR|COMPOSITE_COMPONENT_FAILURE',
                    'message' => '<string>',
                ],
                'state' => 'INITIALIZING|PROCESSING|DELETED|IN_SYNC|ERROR',
            ],
            'updateDateTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

The string that specifies the next page of results.

syncResources

: Type: Array of SyncResourceSummary structures

The sync resources.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ServiceQuotaExceededException:: The service quota was exceeded.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all tags associated with a resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken

: Type: string

The string that specifies the next page of results.

resourceARN

: Required: Yes
: Type: string

The ARN of the resource.

Result Syntax

[
    'nextToken' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Members

nextToken

: Type: string

The string that specifies the next page of results.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

Metadata that you can use to manage a resource.

Errors

AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.

ListWorkspaces

$result = $client->listWorkspaces([/* ... */]);
$promise = $client->listWorkspacesAsync([/* ... */]);

Retrieves information about workspaces in the current account.

Parameter Syntax

$result = $client->listWorkspaces([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken

: Type: string

The string that specifies the next page of results.

Result Syntax

[
    'nextToken' => '<string>',
    'workspaceSummaries' => [
        [
            'arn' => '<string>',
            'creationDateTime' => <DateTime>,
            'description' => '<string>',
            'linkedServices' => ['<string>', ...],
            'updateDateTime' => <DateTime>,
            'workspaceId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

The string that specifies the next page of results.

workspaceSummaries

: Type: Array of WorkspaceSummary structures

A list of objects that contain information about the workspaces.

Errors

InternalServerException:: An unexpected error has occurred.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ServiceQuotaExceededException:: The service quota was exceeded.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds tags to a resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceARN' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceARN

: Required: Yes
: Type: string

The ARN of the resource.

tags

: Required: Yes
: Type: Associative array of custom strings keys (TagKey) to strings

Metadata to add to this resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

TooManyTagsException:: The number of tags exceeds the limit.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceARN' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceARN

: Required: Yes
: Type: string

The ARN of the resource.

tagKeys

: Required: Yes
: Type: Array of strings

A list of tag key names to remove from the resource. You don't specify the value. Both the key and its associated value are removed.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.

UpdateComponentType

$result = $client->updateComponentType([/* ... */]);
$promise = $client->updateComponentTypeAsync([/* ... */]);

Updates information in a component type.

Parameter Syntax

$result = $client->updateComponentType([
    'componentTypeId' => '<string>', // REQUIRED
    'componentTypeName' => '<string>',
    'compositeComponentTypes' => [
        '<Name>' => [
            'componentTypeId' => '<string>',
        ],
        // ...
    ],
    'description' => '<string>',
    'extendsFrom' => ['<string>', ...],
    'functions' => [
        '<Name>' => [
            'implementedBy' => [
                'isNative' => true || false,
                'lambda' => [
                    'arn' => '<string>', // REQUIRED
                ],
            ],
            'requiredProperties' => ['<string>', ...],
            'scope' => 'ENTITY|WORKSPACE',
        ],
        // ...
    ],
    'isSingleton' => true || false,
    'propertyDefinitions' => [
        '<Name>' => [
            'configuration' => ['<string>', ...],
            'dataType' => [
                'allowedValues' => [
                    [
                        'booleanValue' => true || false,
                        'doubleValue' => <float>,
                        'expression' => '<string>',
                        'integerValue' => <integer>,
                        'listValue' => [...], // RECURSIVE
                        'longValue' => <integer>,
                        'mapValue' => [
                            '<String>' => [...], // RECURSIVE
                            // ...
                        ],
                        'relationshipValue' => [
                            'targetComponentName' => '<string>',
                            'targetEntityId' => '<string>',
                        ],
                        'stringValue' => '<string>',
                    ],
                    // ...
                ],
                'nestedType' => [...], // RECURSIVE
                'relationship' => [
                    'relationshipType' => '<string>',
                    'targetComponentTypeId' => '<string>',
                ],
                'type' => 'RELATIONSHIP|STRING|LONG|BOOLEAN|INTEGER|DOUBLE|LIST|MAP', // REQUIRED
                'unitOfMeasure' => '<string>',
            ],
            'defaultValue' => [
                'booleanValue' => true || false,
                'doubleValue' => <float>,
                'expression' => '<string>',
                'integerValue' => <integer>,
                'listValue' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'longValue' => <integer>,
                'mapValue' => [
                    '<String>' => [...], // RECURSIVE
                    // ...
                ],
                'relationshipValue' => [
                    'targetComponentName' => '<string>',
                    'targetEntityId' => '<string>',
                ],
                'stringValue' => '<string>',
            ],
            'displayName' => '<string>',
            'isExternalId' => true || false,
            'isRequiredInEntity' => true || false,
            'isStoredExternally' => true || false,
            'isTimeSeries' => true || false,
        ],
        // ...
    ],
    'propertyGroups' => [
        '<Name>' => [
            'groupType' => 'TABULAR',
            'propertyNames' => ['<string>', ...],
        ],
        // ...
    ],
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

componentTypeId

: Required: Yes
: Type: string

The ID of the component type.

componentTypeName

: Type: string

The component type name.

compositeComponentTypes

: Type: Associative array of custom strings keys (Name) to CompositeComponentTypeRequest structures

This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.

description

: Type: string

The description of the component type.

extendsFrom

: Type: Array of strings

Specifies the component type that this component type extends.

functions

: Type: Associative array of custom strings keys (Name) to FunctionRequest structures

An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

isSingleton

: Type: boolean

A Boolean value that specifies whether an entity can have more than one component of this type.

propertyDefinitions

: Type: Associative array of custom strings keys (Name) to PropertyDefinitionRequest structures

An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

propertyGroups

: Type: Associative array of custom strings keys (Name) to PropertyGroupRequest structures

The property groups.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace.

Result Syntax

[
    'arn' => '<string>',
    'componentTypeId' => '<string>',
    'state' => 'CREATING|UPDATING|DELETING|ACTIVE|ERROR',
    'workspaceId' => '<string>',
]

Result Details

Members

arn

: Required: Yes
: Type: string

The ARN of the component type.

componentTypeId

: Required: Yes
: Type: string

The ID of the component type.

state

: Required: Yes
: Type: string

The current state of the component type.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace that contains the component type.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ServiceQuotaExceededException:: The service quota was exceeded.

UpdateEntity

$result = $client->updateEntity([/* ... */]);
$promise = $client->updateEntityAsync([/* ... */]);

Updates an entity.

Parameter Syntax

$result = $client->updateEntity([
    'componentUpdates' => [
        '<Name>' => [
            'componentTypeId' => '<string>',
            'description' => '<string>',
            'propertyGroupUpdates' => [
                '<Name>' => [
                    'groupType' => 'TABULAR',
                    'propertyNames' => ['<string>', ...],
                    'updateType' => 'UPDATE|DELETE|CREATE',
                ],
                // ...
            ],
            'propertyUpdates' => [
                '<Name>' => [
                    'definition' => [
                        'configuration' => ['<string>', ...],
                        'dataType' => [
                            'allowedValues' => [
                                [
                                    'booleanValue' => true || false,
                                    'doubleValue' => <float>,
                                    'expression' => '<string>',
                                    'integerValue' => <integer>,
                                    'listValue' => [...], // RECURSIVE
                                    'longValue' => <integer>,
                                    'mapValue' => [
                                        '<String>' => [...], // RECURSIVE
                                        // ...
                                    ],
                                    'relationshipValue' => [
                                        'targetComponentName' => '<string>',
                                        'targetEntityId' => '<string>',
                                    ],
                                    'stringValue' => '<string>',
                                ],
                                // ...
                            ],
                            'nestedType' => [...], // RECURSIVE
                            'relationship' => [
                                'relationshipType' => '<string>',
                                'targetComponentTypeId' => '<string>',
                            ],
                            'type' => 'RELATIONSHIP|STRING|LONG|BOOLEAN|INTEGER|DOUBLE|LIST|MAP', // REQUIRED
                            'unitOfMeasure' => '<string>',
                        ],
                        'defaultValue' => [
                            'booleanValue' => true || false,
                            'doubleValue' => <float>,
                            'expression' => '<string>',
                            'integerValue' => <integer>,
                            'listValue' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'longValue' => <integer>,
                            'mapValue' => [
                                '<String>' => [...], // RECURSIVE
                                // ...
                            ],
                            'relationshipValue' => [
                                'targetComponentName' => '<string>',
                                'targetEntityId' => '<string>',
                            ],
                            'stringValue' => '<string>',
                        ],
                        'displayName' => '<string>',
                        'isExternalId' => true || false,
                        'isRequiredInEntity' => true || false,
                        'isStoredExternally' => true || false,
                        'isTimeSeries' => true || false,
                    ],
                    'updateType' => 'UPDATE|DELETE|CREATE|RESET_VALUE',
                    'value' => [
                        'booleanValue' => true || false,
                        'doubleValue' => <float>,
                        'expression' => '<string>',
                        'integerValue' => <integer>,
                        'listValue' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'longValue' => <integer>,
                        'mapValue' => [
                            '<String>' => [...], // RECURSIVE
                            // ...
                        ],
                        'relationshipValue' => [
                            'targetComponentName' => '<string>',
                            'targetEntityId' => '<string>',
                        ],
                        'stringValue' => '<string>',
                    ],
                ],
                // ...
            ],
            'updateType' => 'CREATE|UPDATE|DELETE',
        ],
        // ...
    ],
    'compositeComponentUpdates' => [
        '<ComponentPath>' => [
            'description' => '<string>',
            'propertyGroupUpdates' => [
                '<Name>' => [
                    'groupType' => 'TABULAR',
                    'propertyNames' => ['<string>', ...],
                    'updateType' => 'UPDATE|DELETE|CREATE',
                ],
                // ...
            ],
            'propertyUpdates' => [
                '<Name>' => [
                    'definition' => [
                        'configuration' => ['<string>', ...],
                        'dataType' => [
                            'allowedValues' => [
                                [
                                    'booleanValue' => true || false,
                                    'doubleValue' => <float>,
                                    'expression' => '<string>',
                                    'integerValue' => <integer>,
                                    'listValue' => [...], // RECURSIVE
                                    'longValue' => <integer>,
                                    'mapValue' => [
                                        '<String>' => [...], // RECURSIVE
                                        // ...
                                    ],
                                    'relationshipValue' => [
                                        'targetComponentName' => '<string>',
                                        'targetEntityId' => '<string>',
                                    ],
                                    'stringValue' => '<string>',
                                ],
                                // ...
                            ],
                            'nestedType' => [...], // RECURSIVE
                            'relationship' => [
                                'relationshipType' => '<string>',
                                'targetComponentTypeId' => '<string>',
                            ],
                            'type' => 'RELATIONSHIP|STRING|LONG|BOOLEAN|INTEGER|DOUBLE|LIST|MAP', // REQUIRED
                            'unitOfMeasure' => '<string>',
                        ],
                        'defaultValue' => [
                            'booleanValue' => true || false,
                            'doubleValue' => <float>,
                            'expression' => '<string>',
                            'integerValue' => <integer>,
                            'listValue' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'longValue' => <integer>,
                            'mapValue' => [
                                '<String>' => [...], // RECURSIVE
                                // ...
                            ],
                            'relationshipValue' => [
                                'targetComponentName' => '<string>',
                                'targetEntityId' => '<string>',
                            ],
                            'stringValue' => '<string>',
                        ],
                        'displayName' => '<string>',
                        'isExternalId' => true || false,
                        'isRequiredInEntity' => true || false,
                        'isStoredExternally' => true || false,
                        'isTimeSeries' => true || false,
                    ],
                    'updateType' => 'UPDATE|DELETE|CREATE|RESET_VALUE',
                    'value' => [
                        'booleanValue' => true || false,
                        'doubleValue' => <float>,
                        'expression' => '<string>',
                        'integerValue' => <integer>,
                        'listValue' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'longValue' => <integer>,
                        'mapValue' => [
                            '<String>' => [...], // RECURSIVE
                            // ...
                        ],
                        'relationshipValue' => [
                            'targetComponentName' => '<string>',
                            'targetEntityId' => '<string>',
                        ],
                        'stringValue' => '<string>',
                    ],
                ],
                // ...
            ],
            'updateType' => 'CREATE|UPDATE|DELETE',
        ],
        // ...
    ],
    'description' => '<string>',
    'entityId' => '<string>', // REQUIRED
    'entityName' => '<string>',
    'parentEntityUpdate' => [
        'parentEntityId' => '<string>',
        'updateType' => 'UPDATE|DELETE', // REQUIRED
    ],
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

componentUpdates

: Type: Associative array of custom strings keys (Name) to ComponentUpdateRequest structures

An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.

compositeComponentUpdates

: Type: Associative array of custom strings keys (ComponentPath) to CompositeComponentUpdateRequest structures

This is an object that maps strings to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent.

description

: Type: string

The description of the entity.

entityId

: Required: Yes
: Type: string

The ID of the entity.

entityName

: Type: string

The name of the entity.

parentEntityUpdate

: Type: ParentEntityUpdateRequest structure

An object that describes the update request for a parent entity.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace that contains the entity.

Result Syntax

[
    'state' => 'CREATING|UPDATING|DELETING|ACTIVE|ERROR',
    'updateDateTime' => <DateTime>,
]

Result Details

Members

state

: Required: Yes
: Type: string

The current state of the entity update.

updateDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the entity was last updated.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ConflictException:: A conflict occurred.
ServiceQuotaExceededException:: The service quota was exceeded.

UpdatePricingPlan

$result = $client->updatePricingPlan([/* ... */]);
$promise = $client->updatePricingPlanAsync([/* ... */]);

Update the pricing plan.

Parameter Syntax

$result = $client->updatePricingPlan([
    'bundleNames' => ['<string>', ...],
    'pricingMode' => 'BASIC|STANDARD|TIERED_BUNDLE', // REQUIRED
]);

Parameter Details

Members

bundleNames

: Type: Array of strings

The bundle names.

pricingMode

: Required: Yes
: Type: string

The pricing mode.

Result Syntax

[
    'currentPricingPlan' => [
        'billableEntityCount' => <integer>,
        'bundleInformation' => [
            'bundleNames' => ['<string>', ...],
            'pricingTier' => 'TIER_1|TIER_2|TIER_3|TIER_4',
        ],
        'effectiveDateTime' => <DateTime>,
        'pricingMode' => 'BASIC|STANDARD|TIERED_BUNDLE',
        'updateDateTime' => <DateTime>,
        'updateReason' => 'DEFAULT|PRICING_TIER_UPDATE|ENTITY_COUNT_UPDATE|PRICING_MODE_UPDATE|OVERWRITTEN',
    ],
    'pendingPricingPlan' => [
        'billableEntityCount' => <integer>,
        'bundleInformation' => [
            'bundleNames' => ['<string>', ...],
            'pricingTier' => 'TIER_1|TIER_2|TIER_3|TIER_4',
        ],
        'effectiveDateTime' => <DateTime>,
        'pricingMode' => 'BASIC|STANDARD|TIERED_BUNDLE',
        'updateDateTime' => <DateTime>,
        'updateReason' => 'DEFAULT|PRICING_TIER_UPDATE|ENTITY_COUNT_UPDATE|PRICING_MODE_UPDATE|OVERWRITTEN',
    ],
]

Result Details

Members

currentPricingPlan

: Required: Yes
: Type: PricingPlan structure

Update the current pricing plan.

pendingPricingPlan

: Type: PricingPlan structure

Update the pending pricing plan.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed

UpdateScene

$result = $client->updateScene([/* ... */]);
$promise = $client->updateSceneAsync([/* ... */]);

Updates a scene.

Parameter Syntax

$result = $client->updateScene([
    'capabilities' => ['<string>', ...],
    'contentLocation' => '<string>',
    'description' => '<string>',
    'sceneId' => '<string>', // REQUIRED
    'sceneMetadata' => ['<string>', ...],
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

capabilities

: Type: Array of strings

A list of capabilities that the scene uses to render.

contentLocation

: Type: string

The relative path that specifies the location of the content definition file.

description

: Type: string

The description of this scene.

sceneId

: Required: Yes
: Type: string

The ID of the scene.

sceneMetadata

: Type: Associative array of custom strings keys (Name) to strings

The scene metadata.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace that contains the scene.

Result Syntax

[
    'updateDateTime' => <DateTime>,
]

Result Details

Members

updateDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the scene was last updated.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed

UpdateWorkspace

$result = $client->updateWorkspace([/* ... */]);
$promise = $client->updateWorkspaceAsync([/* ... */]);

Updates a workspace.

Parameter Syntax

$result = $client->updateWorkspace([
    'description' => '<string>',
    'role' => '<string>',
    's3Location' => '<string>',
    'workspaceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

description

: Type: string

The description of the workspace.

role

: Type: string

The ARN of the execution role associated with the workspace.

s3Location

: Type: string

The ARN of the S3 bucket where resources associated with the workspace are stored.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace.

Result Syntax

[
    'updateDateTime' => <DateTime>,
]

Result Details

Members

updateDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time of the current update.

Errors

InternalServerException:: An unexpected error has occurred.
AccessDeniedException:: Access is denied.
ResourceNotFoundException:: The resource wasn't found.
ThrottlingException:: The rate exceeds the limit.
ValidationException:: Failed
ServiceQuotaExceededException:: The service quota was exceeded.

Shapes

AccessDeniedException

Description

Access is denied.

Members

message

: Type: string

BatchPutPropertyError

Description

An error returned by the BatchPutProperty action.

Members

entry

: Required: Yes
: Type: PropertyValueEntry structure

An object that contains information about errors returned by the BatchPutProperty action.

errorCode

: Required: Yes
: Type: string

The error code.

errorMessage

: Required: Yes
: Type: string

The error message.

BatchPutPropertyErrorEntry

Description

An object that contains information about errors returned by the BatchPutProperty action.

Members

errors

: Required: Yes
: Type: Array of BatchPutPropertyError structures

A list of objects that contain information about errors returned by the BatchPutProperty action.

BundleInformation

Description

Information about the pricing bundle.

Members

bundleNames

: Required: Yes
: Type: Array of strings

The bundle names.

pricingTier

: Type: string

The pricing tier.

ColumnDescription

Description

A description of the column in the query results.

Members

name

: Type: string

The name of the column description.

type

: Type: string

The type of the column description.

ComponentPropertyGroupRequest

Description

The component property group request.

Members

groupType

: Type: string

The group type.

propertyNames

: Type: Array of strings

The property names.

updateType

: Type: string

The update type.

ComponentPropertyGroupResponse

Description

The component property group response.

Members

groupType

: Required: Yes
: Type: string

The group type.

isInherited

: Required: Yes
: Type: boolean

A Boolean value that specifies whether the property group is inherited from a parent entity

propertyNames

: Required: Yes
: Type: Array of strings

The names of properties

ComponentRequest

Description

An object that sets information about a component type create or update request.

Members

componentTypeId

: Type: string

The ID of the component type.

description

: Type: string

The description of the component request.

properties

: Type: Associative array of custom strings keys (Name) to PropertyRequest structures

An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.

propertyGroups

: Type: Associative array of custom strings keys (Name) to ComponentPropertyGroupRequest structures

The property groups.

ComponentResponse

Description

An object that returns information about a component type create or update request.

Members

areAllCompositeComponentsReturned

: Type: boolean

This flag notes whether all compositeComponents are returned in the API response.

areAllPropertiesReturned

: Type: boolean

This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.

componentName

: Type: string

The name of the component.

componentTypeId

: Type: string

The ID of the component type.

compositeComponents

: Type: Associative array of custom strings keys (Name) to ComponentSummary structures

This lists objects that contain information about the compositeComponents.

definedIn

: Type: string

The name of the property definition set in the request.

description

: Type: string

The description of the component type.

properties

: Type: Associative array of custom strings keys (Name) to PropertyResponse structures

An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.

propertyGroups

: Type: Associative array of custom strings keys (Name) to ComponentPropertyGroupResponse structures

The property groups.

status

: Type: Status structure

The status of the component type.

syncSource

: Type: string

The syncSource of the sync job, if this entity was created by a sync job.

ComponentSummary

Description

An object that returns information about a component summary.

Members

componentName

: Required: Yes
: Type: string

The name of the component.

componentPath

: Type: string

This string specifies the path to the composite component, starting from the top-level component.

componentTypeId

: Required: Yes
: Type: string

The ID of the component type.

definedIn

: Type: string

The name of the property definition set in the request.

description

: Type: string

The description of the component request.

propertyGroups

: Type: Associative array of custom strings keys (Name) to ComponentPropertyGroupResponse structures

The property groups.

status

: Required: Yes
: Type: Status structure

The status of the component type.

syncSource

: Type: string

The syncSource of the sync job, if this entity was created by a sync job.

ComponentTypeSummary

Description

An object that contains information about a component type.

Members

arn

: Required: Yes
: Type: string

The ARN of the component type.

componentTypeId

: Required: Yes
: Type: string

The ID of the component type.

componentTypeName

: Type: string

The component type name.

creationDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the component type was created.

description

: Type: string

The description of the component type.

status

: Type: Status structure

The current status of the component type.

updateDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the component type was last updated.

ComponentUpdateRequest

Description

The component update request.

Members

componentTypeId

: Type: string

The ID of the component type.

description

: Type: string

The description of the component type.

propertyGroupUpdates

: Type: Associative array of custom strings keys (Name) to ComponentPropertyGroupRequest structures

The property group updates.

propertyUpdates

: Type: Associative array of custom strings keys (Name) to PropertyRequest structures

An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object.

updateType

: Type: string

The update type of the component update request.

CompositeComponentRequest

Description

An object that sets information about the composite component update request.

Members

description

: Type: string

The description of the component type.

properties

: Type: Associative array of custom strings keys (Name) to PropertyRequest structures

This is an object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.

propertyGroups

: Type: Associative array of custom strings keys (Name) to ComponentPropertyGroupRequest structures

The property groups.

CompositeComponentTypeRequest

Description

An object that sets information about the composite component types of a component type.

Members

componentTypeId

: Type: string

This is the componentTypeId that the compositeComponentType refers to.

CompositeComponentTypeResponse

Description

An object that returns information about the composite component types of a component type.

Members

componentTypeId

: Type: string

This is the componentTypeId that this compositeComponentType refers to.

isInherited

: Type: boolean

This boolean indicates whether this compositeComponentType is inherited from its parent.

CompositeComponentUpdateRequest

Description

An object that sets information about the composite component update request.

Members

description

: Type: string

The description of the component type.

propertyGroupUpdates

: Type: Associative array of custom strings keys (Name) to ComponentPropertyGroupRequest structures

The property group updates.

propertyUpdates

: Type: Associative array of custom strings keys (Name) to PropertyRequest structures

An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object.

updateType

: Type: string

The update type of the component update request.

ConflictException

Description

A conflict occurred.

Members

message

: Type: string

ConnectorFailureException

Description

The connector failed.

Members

message

: Type: string

ConnectorTimeoutException

Description

The connector timed out.

Members

message

: Type: string

DataConnector

Description

The data connector.

Members

isNative

: Type: boolean

A Boolean value that specifies whether the data connector is native to IoT TwinMaker.

lambda

: Type: LambdaFunction structure

The Lambda function associated with this data connector.

DataType

Description

An object that specifies the data type of a property.

Members

allowedValues

: Type: Array of DataValue structures

The allowed values for this data type.

nestedType

: Type: DataType structure

The nested type in the data type.

relationship

: Type: Relationship structure

A relationship that associates a component with another component.

type

: Required: Yes
: Type: string

The underlying type of the data type.

unitOfMeasure

: Type: string

The unit of measure used in this data type.

DataValue

Description

An object that specifies a value for a property.

Members

booleanValue

: Type: boolean

A Boolean value.

doubleValue

: Type: double

A double value.

expression

: Type: string

An expression that produces the value.

integerValue

: Type: int

An integer value.

listValue

: Type: Array of DataValue structures

A list of multiple values.

longValue

: Type: long (int|float)

A long value.

mapValue

: Type: Associative array of custom strings keys (String) to DataValue structures

An object that maps strings to multiple DataValue objects.

relationshipValue

: Type: RelationshipValue structure

A value that relates a component to another component.

stringValue

: Type: string

A string value.

DestinationConfiguration

Description

The [link to action] metadata transfer job destination configuration.

Members

iotTwinMakerConfiguration

: Type: IotTwinMakerDestinationConfiguration structure

The metadata transfer job Amazon Web Services IoT TwinMaker configuration.

s3Configuration

: Type: S3DestinationConfiguration structure

The metadata transfer job S3 configuration. [need to add S3 entity]

type

: Required: Yes
: Type: string

The destination type.

EntityPropertyReference

Description

An object that uniquely identifies an entity property.

Members

componentName

: Type: string

The name of the component.

componentPath

: Type: string

This string specifies the path to the composite component, starting from the top-level component.

entityId

: Type: string

The ID of the entity.

externalIdProperty

: Type: Associative array of custom strings keys (String) to strings

A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.

propertyName

: Required: Yes
: Type: string

The name of the property.

EntitySummary

Description

An object that contains information about an entity.

Members

arn

: Required: Yes
: Type: string

The ARN of the entity.

creationDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the entity was created.

description

: Type: string

The description of the entity.

entityId

: Required: Yes
: Type: string

The ID of the entity.

entityName

: Required: Yes
: Type: string

The name of the entity.

hasChildEntities

: Type: boolean

An eventual Boolean value that specifies whether the entity has child entities or not.

parentEntityId

: Type: string

The ID of the parent entity.

status

: Required: Yes
: Type: Status structure

The current status of the entity.

updateDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The last date and time when the entity was updated.

ErrorDetails

Description

The error details.

Members

code

: Type: string

The error code.

message

: Type: string

The error message.

FilterByAsset

Description

Filter by asset. [TwinMaker asset]

Members

assetExternalId

: Type: string

The external-Id property of an asset.

assetId

: Type: string

Filter by asset Id.

includeAssetModel

: Type: boolean

Boolean to include the asset model.

includeOffspring

: Type: boolean

Includes sub-assets.[need description hekp for this]

FilterByAssetModel

Description

Filter by asset model.

Members

assetModelExternalId

: Type: string

The external-Id property of an asset model.

assetModelId

: Type: string

The asset model Id.

includeAssets

: Type: boolean

Bolean to include assets.

includeOffspring

: Type: boolean

Include asset offspring. [need desc.]

FilterByComponentType

Description

Filter by component type.

Members

componentTypeId

: Required: Yes
: Type: string

The component type Id.

FilterByEntity

Description

Vilter by entity.

Members

entityId

: Required: Yes
: Type: string

The entity Id.

FunctionRequest

Description

The function request body.

Members

implementedBy

: Type: DataConnector structure

The data connector.

requiredProperties

: Type: Array of strings

The required properties of the function.

scope

: Type: string

The scope of the function.

FunctionResponse

Description

The function response.

Members

implementedBy

: Type: DataConnector structure

The data connector.

isInherited

: Type: boolean

Indicates whether this function is inherited.

requiredProperties

: Type: Array of strings

The required properties of the function.

scope

: Type: string

The scope of the function.

InternalServerException

Description

An unexpected error has occurred.

Members

message

: Type: string

InterpolationParameters

Description

An object that specifies how to interpolate data in a list.

Members

interpolationType

: Type: string

The interpolation type.

intervalInSeconds

: Type: long (int|float)

The interpolation time interval in seconds.

IotSiteWiseSourceConfiguration

Description

The metadata transfer job AWS IoT SiteWise source configuration.

Members

filters

: Type: Array of IotSiteWiseSourceConfigurationFilter structures

The AWS IoT SiteWise soucre configuration filters.

IotSiteWiseSourceConfigurationFilter

Description

The AWS IoT SiteWise soucre configuration filter.[need held with desc here]

Members

filterByAsset

: Type: FilterByAsset structure

Filter by asset.

filterByAssetModel

: Type: FilterByAssetModel structure

Filter by asset model.

IotTwinMakerDestinationConfiguration

Description

The metadata transfer job AWS IoT TwinMaker destination configuration.

Members

workspace

: Required: Yes
: Type: string

The IoT TwinMaker workspace.

IotTwinMakerSourceConfiguration

Description

The metadata transfer job AWS IoT TwinMaker source configuration.

Members

filters

: Type: Array of IotTwinMakerSourceConfigurationFilter structures

The metadata transfer job AWS IoT TwinMaker source configuration filters.

workspace

: Required: Yes
: Type: string

The IoT TwinMaker workspace.

IotTwinMakerSourceConfigurationFilter

Description

The metadata transfer job AWS IoT TwinMaker source configuration filter.

Members

filterByComponentType

: Type: FilterByComponentType structure

Filter by component type.

filterByEntity

: Type: FilterByEntity structure

Filter by entity.

LambdaFunction

Description

The Lambda function.

Members

arn

: Required: Yes
: Type: string

The ARN of the Lambda function.

ListComponentTypesFilter

Description

An object that filters items in a list of component types.

Only one object is accepted as a valid input.

Members

extendsFrom

: Type: string

The component type that the component types in the list extend.

isAbstract

: Type: boolean

A Boolean value that specifies whether the component types in the list are abstract.

namespace

: Type: string

The namespace to which the component types in the list belong.

ListEntitiesFilter

Description

An object that filters items in a list of entities.

Members

componentTypeId

: Type: string

The ID of the component type in the entities in the list.

externalId

: Type: string

The external-Id property of a component. The external-Id property is the primary key of an external storage system.

parentEntityId

: Type: string

The parent of the entities in the list.

ListMetadataTransferJobsFilter

Description

The ListMetadataTransferJobs filter.

Members

state

: Type: string

The filter state.

workspaceId

: Type: string

The workspace Id.

MetadataTransferJobProgress

Description

The metadata transfer job's progress.

Members

failedCount

: Type: int

The failed count.

skippedCount

: Type: int

The skipped count.

succeededCount

: Type: int

The succeeded count.

totalCount

: Type: int

The total count. [of what]

MetadataTransferJobStatus

Description

The metadata transfer job status.

Members

error

: Type: ErrorDetails structure

The metadata transfer job error.

queuedPosition

: Type: int

The queued position.

state

: Type: string

The metadata transfer job state.

MetadataTransferJobSummary

Description

The metadata transfer job summary.

Members

arn

: Required: Yes
: Type: string

The metadata transfer job summary ARN.

creationDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The metadata transfer job summary creation DateTime object.

metadataTransferJobId

: Required: Yes
: Type: string

The metadata transfer job summary Id.

progress

: Type: MetadataTransferJobProgress structure

The metadata transfer job summary progess.

status

: Required: Yes
: Type: MetadataTransferJobStatus structure

The metadata transfer job summary status.

updateDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The metadata transfer job summary update DateTime object

OrderBy

Description

Filter criteria that orders the return output. It can be sorted in ascending or descending order.

Members

order

: Type: string

The set order that filters results.

propertyName

: Required: Yes
: Type: string

The property name.

ParentEntityUpdateRequest

Description

The parent entity update request.

Members

parentEntityId

: Type: string

The ID of the parent entity.

updateType

: Required: Yes
: Type: string

The type of the update.

PricingPlan

Description

The pricing plan.

Members

billableEntityCount

: Type: long (int|float)

The billable entity count.

bundleInformation

: Type: BundleInformation structure

The pricing plan's bundle information.

effectiveDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The effective date and time of the pricing plan.

pricingMode

: Required: Yes
: Type: string

The pricing mode.

updateDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The set date and time for updating a pricing plan.

updateReason

: Required: Yes
: Type: string

The update reason for changing a pricing plan.

PropertyDefinitionRequest

Description

An object that sets information about a property.

Members

configuration

: Type: Associative array of custom strings keys (Name) to strings

A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.

dataType

: Type: DataType structure

An object that contains information about the data type.

defaultValue

: Type: DataValue structure

An object that contains the default value.

displayName

: Type: string

A friendly name for the property.

isExternalId

: Type: boolean

A Boolean value that specifies whether the property ID comes from an external data store.

isRequiredInEntity

: Type: boolean

A Boolean value that specifies whether the property is required.

isStoredExternally

: Type: boolean

A Boolean value that specifies whether the property is stored externally.

isTimeSeries

: Type: boolean

A Boolean value that specifies whether the property consists of time series data.

PropertyDefinitionResponse

Description

An object that contains response data from a property definition request.

Members

configuration

: Type: Associative array of custom strings keys (Name) to strings

A mapping that specifies configuration information about the property.

dataType

: Required: Yes
: Type: DataType structure

An object that contains information about the data type.

defaultValue

: Type: DataValue structure

An object that contains the default value.

displayName

: Type: string

A friendly name for the property.

isExternalId

: Required: Yes
: Type: boolean

A Boolean value that specifies whether the property ID comes from an external data store.

isFinal

: Required: Yes
: Type: boolean

A Boolean value that specifies whether the property definition can be updated.

isImported

: Required: Yes
: Type: boolean

A Boolean value that specifies whether the property definition is imported from an external data store.

isInherited

: Required: Yes
: Type: boolean

A Boolean value that specifies whether the property definition is inherited from a parent entity.

isRequiredInEntity

: Required: Yes
: Type: boolean

A Boolean value that specifies whether the property is required in an entity.

isStoredExternally

: Required: Yes
: Type: boolean

A Boolean value that specifies whether the property is stored externally.

isTimeSeries

: Required: Yes
: Type: boolean

A Boolean value that specifies whether the property consists of time series data.

PropertyFilter

Description

An object that filters items returned by a property request.

Members

operator

: Type: string

The operator associated with this property filter.

propertyName

: Type: string

The property name associated with this property filter.

value

: Type: DataValue structure

The value associated with this property filter.

PropertyGroupRequest

Description

Members

groupType

: Type: string

The group type.

propertyNames

: Type: Array of strings

The names of properties.

PropertyGroupResponse

Description

The property group response

Members

groupType

: Required: Yes
: Type: string

The group types.

isInherited

: Required: Yes
: Type: boolean

A Boolean value that specifies whether the property group is inherited from a parent entity

propertyNames

: Required: Yes
: Type: Array of strings

The names of properties.

PropertyLatestValue

Description

The latest value of the property.

Members

propertyReference

: Required: Yes
: Type: EntityPropertyReference structure

An object that specifies information about a property.

propertyValue

: Type: DataValue structure

The value of the property.

PropertyRequest

Description

An object that sets information about a property.

Members

definition

: Type: PropertyDefinitionRequest structure

An object that specifies information about a property.

updateType

: Type: string

The update type of the update property request.

value

: Type: DataValue structure

The value of the property.

PropertyResponse

Description

An object that contains information about a property response.

Members

areAllPropertyValuesReturned

: Type: boolean

This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.

definition

: Type: PropertyDefinitionResponse structure

An object that specifies information about a property.

value

: Type: DataValue structure

The value of the property.

PropertySummary

Description

This is an object that contains the information of a property.

Members

areAllPropertyValuesReturned

: Type: boolean

This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.

definition

: Type: PropertyDefinitionResponse structure

This is the schema for the property.

propertyName

: Required: Yes
: Type: string

This is the name of the property.

value

: Type: DataValue structure

This is the value for the property.

PropertyValue

Description

An object that contains information about a value for a time series property.

Members

time

: Type: string

ISO8601 DateTime of a value for a time series property.

The time for when the property value was recorded in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm].

[YYYY]: year
[MM]: month
[DD]: day
[hh]: hour
[mm]: minute
[ss]: seconds
[.SSSSSSSSS]: additional precision, where precedence is maintained. For example: [.573123] is equal to 573123000 nanoseconds.
Z: default timezone UTC
± HH:mm: time zone offset in Hours and Minutes.

Required sub-fields: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]

timestamp

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of a value for a time series property.

value

: Required: Yes
: Type: DataValue structure

An object that specifies a value for a time series property.

PropertyValueEntry

Description

An object that specifies information about time series property values. This object is used and consumed by the BatchPutPropertyValues action.

Members

entityPropertyReference

: Required: Yes
: Type: EntityPropertyReference structure

An object that contains information about the entity that has the property.

propertyValues

: Type: Array of PropertyValue structures

A list of objects that specify time series property values.

PropertyValueHistory

Description

The history of values for a time series property.

Members

entityPropertyReference

: Required: Yes
: Type: EntityPropertyReference structure

An object that uniquely identifies an entity property.

values

: Type: Array of PropertyValue structures

A list of objects that contain information about the values in the history of a time series property.

QueryResultValue

Members

QueryTimeoutException

Description

The query timeout exception.

Members

message

: Type: string

Relationship

Description

An object that specifies a relationship with another component type.

Members

relationshipType

: Type: string

The type of the relationship.

targetComponentTypeId

: Type: string

The ID of the target component type associated with this relationship.

RelationshipValue

Description

A value that associates a component and an entity.

Members

targetComponentName

: Type: string

The name of the target component associated with the relationship value.

targetEntityId

: Type: string

The ID of the target entity associated with this relationship value.

ResourceNotFoundException

Description

The resource wasn't found.

Members

message

: Type: string

Row

Description

Represents a single row in the query results.

Members

rowData

: Type: Array of document (null|bool|string|numeric) or an (array|associative array) whose members are all valid documentss

The data in a row of query results.

S3DestinationConfiguration

Description

The S3 destination configuration.

Members

location

: Required: Yes
: Type: string

The S3 destination configuration location.

S3SourceConfiguration

Description

The S3 destination source configuration.

Members

location

: Required: Yes
: Type: string

The S3 destination source configuration location.

SceneError

Description

The scene error.

Members

code

: Type: string

The SceneError code.

message

: Type: string

The SceneError message.

SceneSummary

Description

An object that contains information about a scene.

Members

arn

: Required: Yes
: Type: string

The ARN of the scene.

contentLocation

: Required: Yes
: Type: string

The relative path that specifies the location of the content definition file.

creationDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the scene was created.

description

: Type: string

The scene description.

sceneId

: Required: Yes
: Type: string

The ID of the scene.

updateDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the scene was last updated.

ServiceQuotaExceededException

Description

The service quota was exceeded.

Members

message

: Type: string

SourceConfiguration

Description

The source configuration.

Members

iotSiteWiseConfiguration

: Type: IotSiteWiseSourceConfiguration structure

The source configuration IoT SiteWise configuration.

iotTwinMakerConfiguration

: Type: IotTwinMakerSourceConfiguration structure

The source configuration IoT TwinMaker configuration.

s3Configuration

: Type: S3SourceConfiguration structure

The source configuration S3 configuration.

type

: Required: Yes
: Type: string

The source configuration type.

Status

Description

An object that represents the status of an entity, component, component type, or workspace.

Members

error

: Type: ErrorDetails structure

The error message.

state

: Type: string

The current state of the entity, component, component type, or workspace.

SyncJobStatus

Description

The SyncJob status.

Members

error

: Type: ErrorDetails structure

The SyncJob error.

state

: Type: string

The SyncJob status state.

SyncJobSummary

Description

The SyncJob summary.

Members

arn

: Type: string

The SyncJob summary ARN.

creationDateTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date and time.

status

: Type: SyncJobStatus structure

The SyncJob summaries status.

syncSource

: Type: string

The sync source.

updateDateTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The update date and time.

workspaceId

: Type: string

The ID of the workspace that contains the sync job.

SyncResourceFilter

Description

The sync resource filter.

Members

externalId

: Type: string

The external ID.

resourceId

: Type: string

The sync resource filter resource ID.

resourceType

: Type: string

The sync resource filter resource type

state

: Type: string

The sync resource filter's state.

SyncResourceStatus

Description

The sync resource status.

Members

error

: Type: ErrorDetails structure

The status error.

state

: Type: string

The sync resource status state.

SyncResourceSummary

Description

The sync resource summary.

Members

externalId

: Type: string

The external ID.

resourceId

: Type: string

The resource ID.

resourceType

: Type: string

The resource type.

status

: Type: SyncResourceStatus structure

The sync resource summary status.

updateDateTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The update date and time.

TabularConditions

Description

The tabular conditions.

Members

orderBy

: Type: Array of OrderBy structures

Filter criteria that orders the output. It can be sorted in ascending or descending order.

propertyFilters

: Type: Array of PropertyFilter structures

You can filter the request using various logical operators and a key-value format. For example:

{"key": "serverType", "value": "webServer"}

ThrottlingException

Description

The rate exceeds the limit.

Members

message

: Type: string

TooManyTagsException

Description

The number of tags exceeds the limit.

Members

message

: Type: string

ValidationException

Description

Failed

Members

message

: Type: string

WorkspaceSummary

Description

An object that contains information about a workspace.

Members

arn

: Required: Yes
: Type: string

The ARN of the workspace.

creationDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the workspace was created.

description

: Type: string

The description of the workspace.

linkedServices

: Type: Array of strings

A list of services that are linked to the workspace.

updateDateTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the workspace was last updated.

workspaceId

: Required: Yes
: Type: string

The ID of the workspace.

AWS IoT TwinMaker 2021-11-29

Operation Summary

Paginators

Operations

BatchPutPropertyValues

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CancelMetadataTransferJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateComponentType

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateEntity

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateMetadataTransferJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateScene

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateSyncJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateWorkspace

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteComponentType

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteEntity

Parameter Syntax

Parameter Details

Members