IoTSiteWise / Client / create_pipeline

create_pipeline

IoTSiteWise.Client.create_pipeline(**kwargs)

Creates a new pipeline in the specified workspace. A pipeline defines a directed acyclic graph (DAG) of compute nodes, where each node references a task and can declare dependencies on other nodes. Cyclic dependencies are not allowed. Nodes without dependencies run in parallel, while nodes with dependencies wait for all upstream nodes to complete successfully before starting.

You can set environment variables at the pipeline level that are shared across all compute nodes, and override them at the individual compute node level.

See also: AWS API Documentation

Request Syntax

response = client.create_pipeline(
    workspaceName='string',
    pipelineName='string',
    description='string',
    environmentVariables={
        'string': 'string'
    },
    computations=[
        {
            'computeNodeName': 'string',
            'taskName': 'string',
            'environmentVariables': {
                'string': 'string'
            },
            'dependsOn': [
                'string',
            ]
        },
    ],
    tags={
        'string': 'string'
    },
    clientToken='string'
)
Parameters:

  • workspaceName (string) –

    [REQUIRED]

    The name of the workspace.

  • pipelineName (string) –

    [REQUIRED]

    The name of the pipeline to create. Must be unique within the workspace.

  • description (string) – A description of the pipeline.

  • environmentVariables (dict) –

    Environment variables shared across all compute nodes in the pipeline. Individual compute nodes can override these values with their own environment variables.

    • (string) –

      Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)

      • (string) –

        Environment variable value

  • computations (list) –

    [REQUIRED]

    The list of compute nodes that form the pipeline DAG. Each compute node references a task and can declare dependencies on other nodes.

    • (dict) –

      A single compute node in a pipeline DAG. Each compute node references a task and can declare dependencies on other nodes.

      • computeNodeName (string) – [REQUIRED]

        The unique name for this compute node within the pipeline.

      • taskName (string) – [REQUIRED]

        The name of the task to execute for this compute node.

      • environmentVariables (dict) –

        Environment variables specific to this compute node. These override pipeline-level environment variables with the same key.

        • (string) –

          Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)

          • (string) –

            Environment variable value

      • dependsOn (list) –

        A list of compute node names that must complete successfully before this node can start.

        • (string) –

          Reusable resource name with alphanumeric, hyphen, and underscore characters.

  • tags (dict) –

    A list of key-value pairs that contain metadata for the pipeline. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

    • (string) –

      • (string) –

  • clientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'pipelineName': 'string',
    'pipelineArn': 'string',
    'version': 'string',
    'status': {
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        },
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
    }
}

Response Structure

  • (dict) –

    Response structure for CreatePipeline operation.

    • pipelineName (string) –

      The name of the created pipeline.

    • pipelineArn (string) –

      The ARN of the created pipeline.

    • version (string) –

      The version of the newly created pipeline.

    • status (dict) –

      The current lifecycle status of the pipeline.

      • error (dict) –

        Contains associated error information, if any.

        • code (string) –

          The error code.

        • message (string) –

          The error message.

      • state (string) –

        The current status of the resource.

Exceptions