IoTSiteWise / Client / describe_pipeline

describe_pipeline

IoTSiteWise.Client.describe_pipeline(**kwargs)

Retrieves detailed information about a specific pipeline in a workspace.

See also: AWS API Documentation

Request Syntax

response = client.describe_pipeline(
    workspaceName='string',
    pipelineName='string',
    pipelineVersion='string'
)
Parameters:

  • workspaceName (string) –

    [REQUIRED]

    The name of the workspace.

  • pipelineName (string) –

    [REQUIRED]

    The name of the pipeline.

  • pipelineVersion (string) – The version number of the pipeline to retrieve. If not specified, returns the latest version.

Return type:

dict

Returns:

Response Syntax

{
    'pipelineName': 'string',
    'workspaceName': 'string',
    'description': 'string',
    'pipelineArn': 'string',
    'version': 'string',
    'environmentVariables': {
        'string': 'string'
    },
    'computations': [
        {
            'computeNodeName': 'string',
            'taskName': 'string',
            'environmentVariables': {
                'string': 'string'
            },
            'dependsOn': [
                'string',
            ]
        },
    ],
    'status': {
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        },
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
    },
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    Response structure for DescribePipeline operation.

    • pipelineName (string) –

      A unique name of the pipeline within the workspace.

    • workspaceName (string) –

      The name of the workspace.

    • description (string) –

      The description of the pipeline.

    • pipelineArn (string) –

      The ARN of the pipeline.

    • version (string) –

      The version of the pipeline.

    • environmentVariables (dict) –

      The environment variables shared across all compute nodes in the pipeline.

      • (string) –

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

        • (string) –

          Environment variable value

    • computations (list) –

      The list of compute nodes that form the pipeline DAG.

      • (dict) –

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

        • computeNodeName (string) –

          The unique name for this compute node within the pipeline.

        • taskName (string) –

          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.

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

    • createdAt (datetime) –

      The time the pipeline was created, in Unix epoch time.

    • updatedAt (datetime) –

      The time the pipeline was last updated, in Unix epoch time.

Exceptions