IoTSiteWise / Client / describe_pipeline_execution

describe_pipeline_execution

IoTSiteWise.Client.describe_pipeline_execution(**kwargs)

Retrieves detailed information about a specific pipeline execution, including the overall execution status and the status of each individual compute node. Use this operation to monitor execution progress and inspect per-node results, environment variables, and error details.

See also: AWS API Documentation

Request Syntax

response = client.describe_pipeline_execution(
    workspaceName='string',
    pipelineName='string',
    pipelineExecutionId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

• workspaceName (string) –

  [REQUIRED]

  The name of the workspace.

• pipelineName (string) –

  [REQUIRED]

  The name of the pipeline.

• pipelineExecutionId (string) –

  [REQUIRED]

  The unique identifier of the pipeline execution.

• nextToken (string) – The token to be used for the next set of paginated results.

• maxResults (integer) – The maximum number of compute nodes to return per request. This is an upper bound; the actual number of results may be less. Default: 50.

Return type:

dict

Returns:

Response Syntax

{
    'pipelineExecutionId': 'string',
    'pipelineName': 'string',
    'workspaceName': 'string',
    'pipelineVersion': 'string',
    'status': {
        'state': 'NOT_STARTED'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED',
        'stateDetails': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'EXECUTION_ERROR'|'TIMED_OUT',
            'message': 'string',
            'details': [
                {
                    'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'EXECUTION_ERROR'|'TIMED_OUT',
                    'message': 'string'
                },
            ]
        }
    },
    'startTime': datetime(2015, 1, 1),
    'endTime': datetime(2015, 1, 1),
    'requestEnvironmentVariables': {
        'global': {
            'string': 'string'
        },
        'computeNodes': {
            'string': {
                'string': 'string'
            }
        }
    },
    'requestMountOverrides': {
        'computeNodes': {
            'string': [
                {
                    'name': 'string',
                    'relativePath': 'string',
                    'source': {
                        's3AccessPoint': {
                            'accessPointArn': 'string',
                            'prefix': 'string'
                        }
                    },
                    'storageType': 'SHARED_STORAGE'
                },
            ]
        }
    },
    'executionPriority': 123,
    'computeNodeExecutionDetails': [
        {
            'computeNodeName': 'string',
            'taskName': 'string',
            'taskArn': 'string',
            'taskVersion': 'string',
            'dependsOn': [
                'string',
            ],
            'status': {
                'state': 'NOT_STARTED'|'QUEUED'|'RUNNING'|'SUCCEEDED'|'FAILED',
                'stateDetails': {
                    'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'EXECUTION_ERROR'|'TIMED_OUT',
                    'message': 'string',
                    'details': [
                        {
                            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'EXECUTION_ERROR'|'TIMED_OUT',
                            'message': 'string'
                        },
                    ]
                }
            },
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1),
            'executionEnvironmentVariables': {
                'string': 'string'
            },
            'executionMounts': [
                {
                    'name': 'string',
                    'relativePath': 'string',
                    'source': {
                        's3AccessPoint': {
                            'accessPointArn': 'string',
                            'prefix': 'string'
                        }
                    },
                    'storageType': 'SHARED_STORAGE'
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  Response structure for DescribePipelineExecution operation.

  • pipelineExecutionId (string) –

    The unique identifier of the pipeline execution.

  • pipelineName (string) –

    The name of the pipeline.

  • workspaceName (string) –

    The name of the workspace.

  • pipelineVersion (string) –

    The pipeline version this execution ran against.

  • status (dict) –

    The current execution status of the pipeline.

    • state (string) –

      Current state of the pipeline execution.

    • stateDetails (dict) –

      Additional information about the execution outcome. Populated when the execution has terminated (failed or cancelled).

      • code (string) –

        Classification of the failure. Present when the execution failed.

      • message (string) –

        Human-readable description of the outcome. For a failed execution, this describes why it failed; for a cancelled execution, this is the reason you supplied when calling CancelPipelineExecution.

      • details (list) –

        Per-step error entries to help diagnose a failed execution. Present when the execution failed.

        • (dict) –

          Contains a detailed error entry for granular troubleshooting of pipeline failures.

          • code (string) –

            The error code.

          • message (string) –

            The associated error message.

  • startTime (datetime) –

    The time the pipeline execution started, in Unix epoch time.

  • endTime (datetime) –

    The time the pipeline execution completed, in Unix epoch time.

  • requestEnvironmentVariables (dict) –

    The environment variables provided as input for the pipeline execution.

    • global (dict) –

      Global environment variables that apply to all compute nodes in the pipeline execution.

      • (string) –

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

        • (string) –

          Environment variable value

    • computeNodes (dict) –

      Per-compute-node environment variable overrides. Each entry maps a compute node name to its environment variable overrides.

      • (string) –

        The compute node name from the pipeline definition.

        • (dict) –

          Environment variable overrides specific to this compute node.

          • (string) –

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

            • (string) –

              Environment variable value

  • requestMountOverrides (dict) –

    The mount overrides provided as input for the pipeline execution. Present when mount overrides were supplied at execution time.

    • computeNodes (dict) –

      The mount overrides for each compute node, keyed by compute node name.

      • (string) –

        The compute node name from the pipeline definition.

        • (list) –

          The mount overrides applied to this compute node for this execution. Each entry is merged into the compute node’s task-defined mounts by mount name: a matching name replaces the task-defined mount, a new name adds a mount, and task-defined mounts not referenced remain unchanged.

          • (dict) –

            Attaches a data source to the container filesystem for a task at a customer-supplied relative path under the service-owned mount root.

            • name (string) –

              A unique name for the mount within the task.

            • relativePath (string) –

              The relative path under the service-owned mount root where this mount is attached inside the container.

            • source (dict) –

              The data source for the mount.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: s3AccessPoint. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              

              • s3AccessPoint (dict) –

                Configuration for a mount that reads from an Amazon S3 access point.

                • accessPointArn (string) –

                  The Amazon Resource Name (ARN) of the S3 access point.

                • prefix (string) –

                  An optional key prefix to scope the mount to a subset of objects at the access point.

            • storageType (string) –

              The type of storage used for the mount.

  • executionPriority (integer) –

    Scheduling priority for the execution. When not specified, defaults to lowest priority.

  • computeNodeExecutionDetails (list) –

    A list of compute node execution details within this pipeline execution.

    • (dict) –

      Contains detailed execution information for a compute node within a pipeline execution.

      • computeNodeName (string) –

        The name of the compute node.

      • taskName (string) –

        The name of the task executed for this compute node.

      • taskArn (string) –

        The ARN of the task.

      • taskVersion (string) –

        The task version that executed for this compute node.

      • dependsOn (list) –

        A list of compute node names that this node depends on.

        • (string) –

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

      • status (dict) –

        The current execution status of the compute node.

        • state (string) –

          Current state of the compute node execution.

        • stateDetails (dict) –

          Additional information about the compute node’s failure. Populated when the compute node has failed.

          • code (string) –

            Classification of the failure.

          • message (string) –

            Human-readable description of why the compute node failed.

          • details (list) –

            Detailed error entries to help diagnose the failure.

            • (dict) –

              Contains a detailed error entry for granular troubleshooting of pipeline failures.

              • code (string) –

                The error code.

              • message (string) –

                The associated error message.

      • startTime (datetime) –

        The time the compute node execution started, in Unix epoch time.

      • endTime (datetime) –

        The time the compute node execution completed, in Unix epoch time.

      • executionEnvironmentVariables (dict) –

        The fully resolved environment variables used for this compute node execution.

        • (string) –

          The environment variable name.

          • (string) –

            The environment variable value.

      • executionMounts (list) –

        The fully resolved mounts used for this compute node execution, after merging task-defined mounts with any execution-level mount overrides. Each mount attaches an external data source to the container filesystem at a relative path under the service-owned mount root.

        • (dict) –

          Attaches a data source to the container filesystem for a task at a customer-supplied relative path under the service-owned mount root.

          • name (string) –

            A unique name for the mount within the task.

          • relativePath (string) –

            The relative path under the service-owned mount root where this mount is attached inside the container.

          • source (dict) –

            The data source for the mount.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: s3AccessPoint. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            

            • s3AccessPoint (dict) –

              Configuration for a mount that reads from an Amazon S3 access point.

              • accessPointArn (string) –

                The Amazon Resource Name (ARN) of the S3 access point.

              • prefix (string) –

                An optional key prefix to scope the mount to a subset of objects at the access point.

          • storageType (string) –

            The type of storage used for the mount.

  • nextToken (string) –

    The token to be used for the next set of paginated results.

Exceptions

• IoTSiteWise.Client.exceptions.InternalFailureException

• IoTSiteWise.Client.exceptions.AccessDeniedException

• IoTSiteWise.Client.exceptions.InvalidRequestException

• IoTSiteWise.Client.exceptions.ResourceNotFoundException

• IoTSiteWise.Client.exceptions.ThrottlingException