IoTTwinMaker / Client / list_properties

list_properties#

IoTTwinMaker.Client.list_properties(**kwargs)#

This API lists the properties of a component.

Request Syntax

response = client.list_properties(
    workspaceId='string',
    componentName='string',
    componentPath='string',
    entityId='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

workspaceId (string) –
[REQUIRED]

The workspace ID.
componentName (string) – The name of the component whose properties are returned by the operation.
componentPath (string) – This string specifies the path to the composite component, starting from the top-level component.
entityId (string) –
[REQUIRED]

The ID for the entity whose metadata (component/properties) is returned by the operation.
maxResults (integer) – The maximum number of results returned at one time. The default is 25.
nextToken (string) – The string that specifies the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'propertySummaries': [
        {
            'definition': {
                'dataType': {
                    'type': 'RELATIONSHIP'|'STRING'|'LONG'|'BOOLEAN'|'INTEGER'|'DOUBLE'|'LIST'|'MAP',
                    'nestedType': {'... recursive ...'},
                    'allowedValues': [
                        {
                            'booleanValue': True|False,
                            'doubleValue': 123.0,
                            'integerValue': 123,
                            'longValue': 123,
                            'stringValue': 'string',
                            'listValue': {'... recursive ...'},
                            'mapValue': {
                                'string': {'... recursive ...'}
                            },
                            'relationshipValue': {
                                'targetEntityId': 'string',
                                'targetComponentName': 'string'
                            },
                            'expression': 'string'
                        },
                    ],
                    'unitOfMeasure': 'string',
                    'relationship': {
                        'targetComponentTypeId': 'string',
                        'relationshipType': 'string'
                    }
                },
                'isTimeSeries': True|False,
                'isRequiredInEntity': True|False,
                'isExternalId': True|False,
                'isStoredExternally': True|False,
                'isImported': True|False,
                'isFinal': True|False,
                'isInherited': True|False,
                'defaultValue': {
                    'booleanValue': True|False,
                    'doubleValue': 123.0,
                    'integerValue': 123,
                    'longValue': 123,
                    'stringValue': 'string',
                    'listValue': [
                        {'... recursive ...'},
                    ],
                    'mapValue': {
                        'string': {'... recursive ...'}
                    },
                    'relationshipValue': {
                        'targetEntityId': 'string',
                        'targetComponentName': 'string'
                    },
                    'expression': 'string'
                },
                'configuration': {
                    'string': 'string'
                },
                'displayName': 'string'
            },
            'propertyName': 'string',
            'value': {
                'booleanValue': True|False,
                'doubleValue': 123.0,
                'integerValue': 123,
                'longValue': 123,
                'stringValue': 'string',
                'listValue': [
                    {'... recursive ...'},
                ],
                'mapValue': {
                    'string': {'... recursive ...'}
                },
                'relationshipValue': {
                    'targetEntityId': 'string',
                    'targetComponentName': 'string'
                },
                'expression': 'string'
            },
            'areAllPropertyValuesReturned': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- propertySummaries (list) –
  
  A list of objects that contain information about the properties.
  - (dict) –
    
    This is an object that contains the information of a property.
    - definition (dict) –
      
      This is the schema for the property.
      - dataType (dict) –
        
        An object that contains information about the data type.
        
        type (string) –
        
        The underlying type of the data type.
        
        nestedType (dict) –
        
        The nested type in the data type.
        
        allowedValues (list) –
        
        The allowed values for this data type.
        
        (dict) –
        
        An object that specifies a value for a property.
        
        booleanValue (boolean) –
        
        A Boolean value.
        
        doubleValue (float) –
        
        A double value.
        
        integerValue (integer) –
        
        An integer value.
        
        longValue (integer) –
        
        A long value.
        
        stringValue (string) –
        
        A string value.
        
        listValue (list) –
        
        A list of multiple values.
        
        mapValue (dict) –
        
        An object that maps strings to multiple DataValue objects.
        
        (string) –
        
        (dict) –
        
        An object that specifies a value for a property.
        
        relationshipValue (dict) –
        
        A value that relates a component to another component.
        
        targetEntityId (string) –
        
        The ID of the target entity associated with this relationship value.
        
        targetComponentName (string) –
        
        The name of the target component associated with the relationship value.
        
        expression (string) –
        
        An expression that produces the value.
        
        unitOfMeasure (string) –
        
        The unit of measure used in this data type.
        
        relationship (dict) –
        
        A relationship that associates a component with another component.
        
        targetComponentTypeId (string) –
        
        The ID of the target component type associated with this relationship.
        
        relationshipType (string) –
        
        The type of the relationship.
      - isTimeSeries (boolean) –
        
        A Boolean value that specifies whether the property consists of time series data.
      - isRequiredInEntity (boolean) –
        
        A Boolean value that specifies whether the property is required in an entity.
      - isExternalId (boolean) –
        
        A Boolean value that specifies whether the property ID comes from an external data store.
      - isStoredExternally (boolean) –
        
        A Boolean value that specifies whether the property is stored externally.
      - isImported (boolean) –
        
        A Boolean value that specifies whether the property definition is imported from an external data store.
      - isFinal (boolean) –
        
        A Boolean value that specifies whether the property definition can be updated.
      - isInherited (boolean) –
        
        A Boolean value that specifies whether the property definition is inherited from a parent entity.
      - defaultValue (dict) –
        
        An object that contains the default value.
        
        booleanValue (boolean) –
        
        A Boolean value.
        
        doubleValue (float) –
        
        A double value.
        
        integerValue (integer) –
        
        An integer value.
        
        longValue (integer) –
        
        A long value.
        
        stringValue (string) –
        
        A string value.
        
        listValue (list) –
        
        A list of multiple values.
        
        (dict) –
        
        An object that specifies a value for a property.
        
        mapValue (dict) –
        
        An object that maps strings to multiple DataValue objects.
        
        (string) –
        
        (dict) –
        
        An object that specifies a value for a property.
        
        relationshipValue (dict) –
        
        A value that relates a component to another component.
        
        targetEntityId (string) –
        
        The ID of the target entity associated with this relationship value.
        
        targetComponentName (string) –
        
        The name of the target component associated with the relationship value.
        
        expression (string) –
        
        An expression that produces the value.
      - configuration (dict) –
        
        A mapping that specifies configuration information about the property.
        
        (string) –
        
        (string) –
      - displayName (string) –
        
        A friendly name for the property.
    - propertyName (string) –
      
      This is the name of the property.
    - value (dict) –
      
      This is the value for the property.
      - booleanValue (boolean) –
        
        A Boolean value.
      - doubleValue (float) –
        
        A double value.
      - integerValue (integer) –
        
        An integer value.
      - longValue (integer) –
        
        A long value.
      - stringValue (string) –
        
        A string value.
      - listValue (list) –
        
        A list of multiple values.
        
        (dict) –
        
        An object that specifies a value for a property.
      - mapValue (dict) –
        
        An object that maps strings to multiple DataValue objects.
        
        (string) –
        
        (dict) –
        
        An object that specifies a value for a property.
      - relationshipValue (dict) –
        
        A value that relates a component to another component.
        
        targetEntityId (string) –
        
        The ID of the target entity associated with this relationship value.
        
        targetComponentName (string) –
        
        The name of the target component associated with the relationship value.
      - expression (string) –
        
        An expression that produces the value.
    - areAllPropertyValuesReturned (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.
- nextToken (string) –
  
  The string that specifies the next page of property results.

list_properties#

Request Syntax

Response Syntax

Response Structure

Exceptions