IoTTwinMaker / Client / batch_put_property_values

batch_put_property_values#

IoTTwinMaker.Client.batch_put_property_values(**kwargs)#

Sets values for multiple time series properties.

See also: AWS API Documentation

Request Syntax

response = client.batch_put_property_values(
    workspaceId='string',
    entries=[
        {
            'entityPropertyReference': {
                'componentName': 'string',
                'componentPath': 'string',
                'externalIdProperty': {
                    'string': 'string'
                },
                'entityId': 'string',
                'propertyName': 'string'
            },
            'propertyValues': [
                {
                    'timestamp': datetime(2015, 1, 1),
                    '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'
                    },
                    'time': 'string'
                },
            ]
        },
    ]
)
Parameters:
  • workspaceId (string) –

    [REQUIRED]

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

  • entries (list) –

    [REQUIRED]

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

    • (dict) –

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

      • entityPropertyReference (dict) – [REQUIRED]

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

        • componentName (string) –

          The name of the component.

        • componentPath (string) –

          This string specifies the path to the composite component, starting from the top-level 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) – [REQUIRED]

          The name of the property.

      • propertyValues (list) –

        A list of objects that specify time series property values.

        • (dict) –

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

          • timestamp (datetime) –

            The timestamp of a value for a time series property.

          • value (dict) – [REQUIRED]

            An object that specifies a value for a time series 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.

          • time (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]

Return type:

dict

Returns:

Response Syntax

{
    'errorEntries': [
        {
            'errors': [
                {
                    'errorCode': 'string',
                    'errorMessage': 'string',
                    'entry': {
                        'entityPropertyReference': {
                            'componentName': 'string',
                            'componentPath': 'string',
                            'externalIdProperty': {
                                'string': 'string'
                            },
                            'entityId': 'string',
                            'propertyName': 'string'
                        },
                        'propertyValues': [
                            {
                                'timestamp': datetime(2015, 1, 1),
                                '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'
                                },
                                'time': 'string'
                            },
                        ]
                    }
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • errorEntries (list) –

      Entries that caused errors in the batch put operation.

      • (dict) –

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

        • errors (list) –

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

          • (dict) –

            An error returned by the BatchPutProperty action.

            • errorCode (string) –

              The error code.

            • errorMessage (string) –

              The error message.

            • entry (dict) –

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

              • entityPropertyReference (dict) –

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

                • componentName (string) –

                  The name of the component.

                • componentPath (string) –

                  This string specifies the path to the composite component, starting from the top-level 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.

              • propertyValues (list) –

                A list of objects that specify time series property values.

                • (dict) –

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

                  • timestamp (datetime) –

                    The timestamp of a value for a time series property.

                  • value (dict) –

                    An object that specifies a value for a time series 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.

                  • time (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]

Exceptions