IoTAnalytics / Client / run_pipeline_activity

run_pipeline_activity#

IoTAnalytics.Client.run_pipeline_activity(**kwargs)#

Simulates the results of running a pipeline activity on a message payload.

Request Syntax

response = client.run_pipeline_activity(
    pipelineActivity={
        'channel': {
            'name': 'string',
            'channelName': 'string',
            'next': 'string'
        },
        'lambda': {
            'name': 'string',
            'lambdaName': 'string',
            'batchSize': 123,
            'next': 'string'
        },
        'datastore': {
            'name': 'string',
            'datastoreName': 'string'
        },
        'addAttributes': {
            'name': 'string',
            'attributes': {
                'string': 'string'
            },
            'next': 'string'
        },
        'removeAttributes': {
            'name': 'string',
            'attributes': [
                'string',
            ],
            'next': 'string'
        },
        'selectAttributes': {
            'name': 'string',
            'attributes': [
                'string',
            ],
            'next': 'string'
        },
        'filter': {
            'name': 'string',
            'filter': 'string',
            'next': 'string'
        },
        'math': {
            'name': 'string',
            'attribute': 'string',
            'math': 'string',
            'next': 'string'
        },
        'deviceRegistryEnrich': {
            'name': 'string',
            'attribute': 'string',
            'thingName': 'string',
            'roleArn': 'string',
            'next': 'string'
        },
        'deviceShadowEnrich': {
            'name': 'string',
            'attribute': 'string',
            'thingName': 'string',
            'roleArn': 'string',
            'next': 'string'
        }
    },
    payloads=[
        b'bytes',
    ]
)

Parameters:

pipelineActivity (dict) –
[REQUIRED]

The pipeline activity that is run. This must not be a channel activity or a data store activity because these activities are used in a pipeline only to load the original message and to store the (possibly) transformed message. If a Lambda activity is specified, only short-running Lambda functions (those with a timeout of less than 30 seconds or less) can be used.
- channel (dict) –
  
  Determines the source of the messages to be processed.
  - name (string) – [REQUIRED]
    
    The name of the channel activity.
  - channelName (string) – [REQUIRED]
    
    The name of the channel from which the messages are processed.
  - next (string) –
    
    The next activity in the pipeline.
- lambda (dict) –
  
  Runs a Lambda function to modify the message.
  - name (string) – [REQUIRED]
    
    The name of the lambda activity.
  - lambdaName (string) – [REQUIRED]
    
    The name of the Lambda function that is run on the message.
  - batchSize (integer) – [REQUIRED]
    
    The number of messages passed to the Lambda function for processing.
    
    The Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions.
  - next (string) –
    
    The next activity in the pipeline.
- datastore (dict) –
  
  Specifies where to store the processed message data.
  - name (string) – [REQUIRED]
    
    The name of the datastore activity.
  - datastoreName (string) – [REQUIRED]
    
    The name of the data store where processed messages are stored.
- addAttributes (dict) –
  
  Adds other attributes based on existing attributes in the message.
  - name (string) – [REQUIRED]
    
    The name of the addAttributes activity.
  - attributes (dict) – [REQUIRED]
    
    A list of 1-50 AttributeNameMapping objects that map an existing attribute to a new attribute.
    
    Note
    
    The existing attributes remain in the message, so if you want to remove the originals, use RemoveAttributeActivity.
    - (string) –
      - (string) –
  - next (string) –
    
    The next activity in the pipeline.
- removeAttributes (dict) –
  
  Removes attributes from a message.
  - name (string) – [REQUIRED]
    
    The name of the removeAttributes activity.
  - attributes (list) – [REQUIRED]
    
    A list of 1-50 attributes to remove from the message.
    - (string) –
  - next (string) –
    
    The next activity in the pipeline.
- selectAttributes (dict) –
  
  Used to create a new message using only the specified attributes from the original message.
  - name (string) – [REQUIRED]
    
    The name of the selectAttributes activity.
  - attributes (list) – [REQUIRED]
    
    A list of the attributes to select from the message.
    - (string) –
  - next (string) –
    
    The next activity in the pipeline.
- filter (dict) –
  
  Filters a message based on its attributes.
  - name (string) – [REQUIRED]
    
    The name of the filter activity.
  - filter (string) – [REQUIRED]
    
    An expression that looks like a SQL WHERE clause that must return a Boolean value. Messages that satisfy the condition are passed to the next activity.
  - next (string) –
    
    The next activity in the pipeline.
- math (dict) –
  
  Computes an arithmetic expression using the message’s attributes and adds it to the message.
  - name (string) – [REQUIRED]
    
    The name of the math activity.
  - attribute (string) – [REQUIRED]
    
    The name of the attribute that contains the result of the math operation.
  - math (string) – [REQUIRED]
    
    An expression that uses one or more existing attributes and must return an integer value.
  - next (string) –
    
    The next activity in the pipeline.
- deviceRegistryEnrich (dict) –
  
  Adds data from the IoT device registry to your message.
  - name (string) – [REQUIRED]
    
    The name of the deviceRegistryEnrich activity.
  - attribute (string) – [REQUIRED]
    
    The name of the attribute that is added to the message.
  - thingName (string) – [REQUIRED]
    
    The name of the IoT device whose registry information is added to the message.
  - roleArn (string) – [REQUIRED]
    
    The ARN of the role that allows access to the device’s registry information.
  - next (string) –
    
    The next activity in the pipeline.
- deviceShadowEnrich (dict) –
  
  Adds information from the IoT Device Shadow service to a message.
  - name (string) – [REQUIRED]
    
    The name of the deviceShadowEnrich activity.
  - attribute (string) – [REQUIRED]
    
    The name of the attribute that is added to the message.
  - thingName (string) – [REQUIRED]
    
    The name of the IoT device whose shadow information is added to the message.
  - roleArn (string) – [REQUIRED]
    
    The ARN of the role that allows access to the device’s shadow.
  - next (string) –
    
    The next activity in the pipeline.
payloads (list) –
[REQUIRED]

The sample message payloads on which the pipeline activity is run.
- (bytes) –

Return type:

dict

Returns:

Response Syntax

{
    'payloads': [
        b'bytes',
    ],
    'logResult': 'string'
}

Response Structure

(dict) –
- payloads (list) –
  
  The enriched or transformed sample message payloads as base64-encoded strings. (The results of running the pipeline activity on each input sample message payload, encoded in base64.)
  - (bytes) –
- logResult (string) –
  
  In case the pipeline activity fails, the log message that is generated.

Exceptions

IoTAnalytics.Client.exceptions.InvalidRequestException
IoTAnalytics.Client.exceptions.InternalFailureException
IoTAnalytics.Client.exceptions.ServiceUnavailableException
IoTAnalytics.Client.exceptions.ThrottlingException