get_property_value

get_property_value(**kwargs)

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

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

See also: AWS API Documentation

Request Syntax

response = client.get_property_value(
    componentName='string',
    componentTypeId='string',
    entityId='string',
    selectedProperties=[
        'string',
    ],
    workspaceId='string',
    maxResults=123,
    nextToken='string',
    propertyGroupName='string',
    tabularConditions={
        'orderBy': [
            {
                'order': 'ASCENDING'|'DESCENDING',
                'propertyName': 'string'
            },
        ],
        'propertyFilters': [
            {
                'propertyName': 'string',
                'operator': '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'
                }
            },
        ]
    }
)

Parameters

• componentName (string) -- The name of the component whose property values the operation returns.
• componentTypeId (string) -- The ID of the component type whose property values the operation returns.
• entityId (string) -- The ID of the entity whose property values the operation returns.
• selectedProperties (list) --

  [REQUIRED]

  The properties whose values the operation returns.

  • (string) --
• workspaceId (string) --

  [REQUIRED]

  The ID of the workspace whose values the operation returns.

• maxResults (integer) --

  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 (string) -- The string that specifies the next page of results.
• propertyGroupName (string) -- The property group name.
• tabularConditions (dict) --

  The tabular conditions.

  • orderBy (list) --

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

    • (dict) --

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

      • order (string) --

        The set order that filters results.

      • propertyName (string) -- [REQUIRED]

        The property name.

  • propertyFilters (list) --

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

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

    • (dict) --

      An object that filters items returned by a property request.

      • propertyName (string) --

        The property name associated with this property filter.

      • operator (string) --

        The operator associated with this property filter.

      • value (dict) --

        The value associated with this property filter.

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

Return type

dict

Returns

Response Syntax

{
    'propertyValues': {
        'string': {
            'propertyReference': {
                'componentName': 'string',
                'externalIdProperty': {
                    'string': 'string'
                },
                'entityId': 'string',
                'propertyName': 'string'
            },
            'propertyValue': {
                'booleanValue': True|False,
                'doubleValue': 123.0,
                'integerValue': 123,
                'longValue': 123,
                'stringValue': 'string',
                'listValue': [
                    {'... recursive ...'},
                ],
                'mapValue': {
                    'string': {'... recursive ...'}
                },
                'relationshipValue': {
                    'targetEntityId': 'string',
                    'targetComponentName': 'string'
                },
                'expression': 'string'
            }
        }
    },
    'nextToken': 'string',
    'tabularPropertyValues': [
        [
            {
                'string': {
                    'booleanValue': True|False,
                    'doubleValue': 123.0,
                    'integerValue': 123,
                    'longValue': 123,
                    'stringValue': 'string',
                    'listValue': [
                        {'... recursive ...'},
                    ],
                    'mapValue': {
                        'string': {'... recursive ...'}
                    },
                    'relationshipValue': {
                        'targetEntityId': 'string',
                        'targetComponentName': 'string'
                    },
                    'expression': 'string'
                }
            },
        ],
    ]
}

Response Structure

• (dict) --

  • propertyValues (dict) --

    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.

    • (string) --

      • (dict) --

        The latest value of the property.

        • propertyReference (dict) --

          An object that specifies information about a property.>

          • componentName (string) --

            The name of the component.

          • externalIdProperty (dict) --

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

            • (string) --
              • (string) --

          • entityId (string) --

            The ID of the entity.

          • propertyName (string) --

            The name of the property.

        • propertyValue (dict) --

          The value of 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.

  • nextToken (string) --

    The string that specifies the next page of results.

  • tabularPropertyValues (list) --

    A table of property values.

    • (list) --

      • (dict) --

        • (string) --

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

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

Exceptions

• IoTTwinMaker.Client.exceptions.InternalServerException
• IoTTwinMaker.Client.exceptions.ConnectorFailureException
• IoTTwinMaker.Client.exceptions.AccessDeniedException
• IoTTwinMaker.Client.exceptions.ResourceNotFoundException
• IoTTwinMaker.Client.exceptions.ThrottlingException
• IoTTwinMaker.Client.exceptions.ValidationException
• IoTTwinMaker.Client.exceptions.ConnectorTimeoutException