:doc:`SageMaker <../../sagemaker>` / Client / list_pipeline_execution_steps

*****************************
list_pipeline_execution_steps
*****************************



.. py:method:: SageMaker.Client.list_pipeline_execution_steps(**kwargs)

  

  Gets a list of ``PipeLineExecutionStep`` objects.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListPipelineExecutionSteps>`_  


  **Request Syntax**
  ::

    response = client.list_pipeline_execution_steps(
        PipelineExecutionArn='string',
        NextToken='string',
        MaxResults=123,
        SortOrder='Ascending'|'Descending'
    )
    
  :type PipelineExecutionArn: string
  :param PipelineExecutionArn: 

    The Amazon Resource Name (ARN) of the pipeline execution.

    

  
  :type NextToken: string
  :param NextToken: 

    If the result of the previous ``ListPipelineExecutionSteps`` request was truncated, the response includes a ``NextToken``. To retrieve the next set of pipeline execution steps, use the token in the next request.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of pipeline execution steps to return in the response.

    

  
  :type SortOrder: string
  :param SortOrder: 

    The field by which to sort results. The default is ``CreatedTime``.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'PipelineExecutionSteps': [
              {
                  'StepName': 'string',
                  'StepDisplayName': 'string',
                  'StepDescription': 'string',
                  'StartTime': datetime(2015, 1, 1),
                  'EndTime': datetime(2015, 1, 1),
                  'StepStatus': 'Starting'|'Executing'|'Stopping'|'Stopped'|'Failed'|'Succeeded',
                  'CacheHitResult': {
                      'SourcePipelineExecutionArn': 'string'
                  },
                  'FailureReason': 'string',
                  'Metadata': {
                      'TrainingJob': {
                          'Arn': 'string'
                      },
                      'ProcessingJob': {
                          'Arn': 'string'
                      },
                      'TransformJob': {
                          'Arn': 'string'
                      },
                      'TuningJob': {
                          'Arn': 'string'
                      },
                      'Model': {
                          'Arn': 'string'
                      },
                      'RegisterModel': {
                          'Arn': 'string'
                      },
                      'Condition': {
                          'Outcome': 'True'|'False'
                      },
                      'Callback': {
                          'CallbackToken': 'string',
                          'SqsQueueUrl': 'string',
                          'OutputParameters': [
                              {
                                  'Name': 'string',
                                  'Value': 'string'
                              },
                          ]
                      },
                      'Lambda': {
                          'Arn': 'string',
                          'OutputParameters': [
                              {
                                  'Name': 'string',
                                  'Value': 'string'
                              },
                          ]
                      },
                      'EMR': {
                          'ClusterId': 'string',
                          'StepId': 'string',
                          'StepName': 'string',
                          'LogFilePath': 'string'
                      },
                      'QualityCheck': {
                          'CheckType': 'string',
                          'BaselineUsedForDriftCheckStatistics': 'string',
                          'BaselineUsedForDriftCheckConstraints': 'string',
                          'CalculatedBaselineStatistics': 'string',
                          'CalculatedBaselineConstraints': 'string',
                          'ModelPackageGroupName': 'string',
                          'ViolationReport': 'string',
                          'CheckJobArn': 'string',
                          'SkipCheck': True|False,
                          'RegisterNewBaseline': True|False
                      },
                      'ClarifyCheck': {
                          'CheckType': 'string',
                          'BaselineUsedForDriftCheckConstraints': 'string',
                          'CalculatedBaselineConstraints': 'string',
                          'ModelPackageGroupName': 'string',
                          'ViolationReport': 'string',
                          'CheckJobArn': 'string',
                          'SkipCheck': True|False,
                          'RegisterNewBaseline': True|False
                      },
                      'Fail': {
                          'ErrorMessage': 'string'
                      },
                      'AutoMLJob': {
                          'Arn': 'string'
                      },
                      'Endpoint': {
                          'Arn': 'string'
                      },
                      'EndpointConfig': {
                          'Arn': 'string'
                      },
                      'BedrockCustomModel': {
                          'Arn': 'string'
                      },
                      'BedrockCustomModelDeployment': {
                          'Arn': 'string'
                      },
                      'BedrockProvisionedModelThroughput': {
                          'Arn': 'string'
                      },
                      'BedrockModelImport': {
                          'Arn': 'string'
                      },
                      'InferenceComponent': {
                          'Arn': 'string'
                      },
                      'Lineage': {
                          'ActionArns': {
                              'string': 'string'
                          },
                          'ArtifactArns': {
                              'string': 'string'
                          },
                          'ContextArns': {
                              'string': 'string'
                          },
                          'Associations': [
                              {
                                  'SourceArn': 'string',
                                  'DestinationArn': 'string'
                              },
                          ]
                      }
                  },
                  'AttemptCount': 123,
                  'SelectiveExecutionResult': {
                      'SourcePipelineExecutionArn': 'string'
                  }
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **PipelineExecutionSteps** *(list) --* 

        A list of ``PipeLineExecutionStep`` objects. Each ``PipeLineExecutionStep`` consists of StepName, StartTime, EndTime, StepStatus, and Metadata. Metadata is an object with properties for each job that contains relevant information about the job created by the step.

        
        

        - *(dict) --* 

          An execution of a step in a pipeline.

          
          

          - **StepName** *(string) --* 

            The name of the step that is executed.

            
          

          - **StepDisplayName** *(string) --* 

            The display name of the step.

            
          

          - **StepDescription** *(string) --* 

            The description of the step.

            
          

          - **StartTime** *(datetime) --* 

            The time that the step started executing.

            
          

          - **EndTime** *(datetime) --* 

            The time that the step stopped executing.

            
          

          - **StepStatus** *(string) --* 

            The status of the step execution.

            
          

          - **CacheHitResult** *(dict) --* 

            If this pipeline execution step was cached, details on the cache hit.

            
            

            - **SourcePipelineExecutionArn** *(string) --* 

              The Amazon Resource Name (ARN) of the pipeline execution.

              
        
          

          - **FailureReason** *(string) --* 

            The reason why the step failed execution. This is only returned if the step failed its execution.

            
          

          - **Metadata** *(dict) --* 

            Metadata to run the pipeline step.

            
            

            - **TrainingJob** *(dict) --* 

              The Amazon Resource Name (ARN) of the training job that was run by this step execution.

              
              

              - **Arn** *(string) --* 

                The Amazon Resource Name (ARN) of the training job that was run by this step execution.

                
          
            

            - **ProcessingJob** *(dict) --* 

              The Amazon Resource Name (ARN) of the processing job that was run by this step execution.

              
              

              - **Arn** *(string) --* 

                The Amazon Resource Name (ARN) of the processing job.

                
          
            

            - **TransformJob** *(dict) --* 

              The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

              
              

              - **Arn** *(string) --* 

                The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

                
          
            

            - **TuningJob** *(dict) --* 

              The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

              
              

              - **Arn** *(string) --* 

                The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

                
          
            

            - **Model** *(dict) --* 

              The Amazon Resource Name (ARN) of the model that was created by this step execution.

              
              

              - **Arn** *(string) --* 

                The Amazon Resource Name (ARN) of the created model.

                
          
            

            - **RegisterModel** *(dict) --* 

              The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.

              
              

              - **Arn** *(string) --* 

                The Amazon Resource Name (ARN) of the model package.

                
          
            

            - **Condition** *(dict) --* 

              The outcome of the condition evaluation that was run by this step execution.

              
              

              - **Outcome** *(string) --* 

                The outcome of the Condition step evaluation.

                
          
            

            - **Callback** *(dict) --* 

              The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.

              
              

              - **CallbackToken** *(string) --* 

                The pipeline generated token from the Amazon SQS queue.

                
              

              - **SqsQueueUrl** *(string) --* 

                The URL of the Amazon Simple Queue Service (Amazon SQS) queue used by the callback step.

                
              

              - **OutputParameters** *(list) --* 

                A list of the output parameters of the callback step.

                
                

                - *(dict) --* 

                  An output parameter of a pipeline step.

                  
                  

                  - **Name** *(string) --* 

                    The name of the output parameter.

                    
                  

                  - **Value** *(string) --* 

                    The value of the output parameter.

                    
              
            
          
            

            - **Lambda** *(dict) --* 

              The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.

              
              

              - **Arn** *(string) --* 

                The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.

                
              

              - **OutputParameters** *(list) --* 

                A list of the output parameters of the Lambda step.

                
                

                - *(dict) --* 

                  An output parameter of a pipeline step.

                  
                  

                  - **Name** *(string) --* 

                    The name of the output parameter.

                    
                  

                  - **Value** *(string) --* 

                    The value of the output parameter.

                    
              
            
          
            

            - **EMR** *(dict) --* 

              The configurations and outcomes of an Amazon EMR step execution.

              
              

              - **ClusterId** *(string) --* 

                The identifier of the EMR cluster.

                
              

              - **StepId** *(string) --* 

                The identifier of the EMR cluster step.

                
              

              - **StepName** *(string) --* 

                The name of the EMR cluster step.

                
              

              - **LogFilePath** *(string) --* 

                The path to the log file where the cluster step's failure root cause is recorded.

                
          
            

            - **QualityCheck** *(dict) --* 

              The configurations and outcomes of the check step execution. This includes:

               

              
              * The type of the check conducted.
               
              * The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
               
              * The Amazon S3 URIs of newly calculated baseline constraints and statistics.
               
              * The model package group name provided.
               
              * The Amazon S3 URI of the violation report if violations detected.
               
              * The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
               
              * The Boolean flags indicating if the drift check is skipped.
               
              * If step property ``BaselineUsedForDriftCheck`` is set the same as ``CalculatedBaseline``.
              

              
              

              - **CheckType** *(string) --* 

                The type of the Quality check step.

                
              

              - **BaselineUsedForDriftCheckStatistics** *(string) --* 

                The Amazon S3 URI of the baseline statistics file used for the drift check.

                
              

              - **BaselineUsedForDriftCheckConstraints** *(string) --* 

                The Amazon S3 URI of the baseline constraints file used for the drift check.

                
              

              - **CalculatedBaselineStatistics** *(string) --* 

                The Amazon S3 URI of the newly calculated baseline statistics file.

                
              

              - **CalculatedBaselineConstraints** *(string) --* 

                The Amazon S3 URI of the newly calculated baseline constraints file.

                
              

              - **ModelPackageGroupName** *(string) --* 

                The model package group name.

                
              

              - **ViolationReport** *(string) --* 

                The Amazon S3 URI of violation report if violations are detected.

                
              

              - **CheckJobArn** *(string) --* 

                The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.

                
              

              - **SkipCheck** *(boolean) --* 

                This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to ``False``, the previous baseline of the configured check type must be available.

                
              

              - **RegisterNewBaseline** *(boolean) --* 

                This flag indicates if a newly calculated baseline can be accessed through step properties ``BaselineUsedForDriftCheckConstraints`` and ``BaselineUsedForDriftCheckStatistics``. If it is set to ``False``, the previous baseline of the configured check type must also be available. These can be accessed through the ``BaselineUsedForDriftCheckConstraints`` and ``BaselineUsedForDriftCheckStatistics`` properties.

                
          
            

            - **ClarifyCheck** *(dict) --* 

              Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution. This includes:

               

              
              * The type of the check conducted,
               
              * The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
               
              * The Amazon S3 URIs of newly calculated baseline constraints and statistics.
               
              * The model package group name provided.
               
              * The Amazon S3 URI of the violation report if violations detected.
               
              * The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
               
              * The boolean flags indicating if the drift check is skipped.
               
              * If step property ``BaselineUsedForDriftCheck`` is set the same as ``CalculatedBaseline``.
              

              
              

              - **CheckType** *(string) --* 

                The type of the Clarify Check step

                
              

              - **BaselineUsedForDriftCheckConstraints** *(string) --* 

                The Amazon S3 URI of baseline constraints file to be used for the drift check.

                
              

              - **CalculatedBaselineConstraints** *(string) --* 

                The Amazon S3 URI of the newly calculated baseline constraints file.

                
              

              - **ModelPackageGroupName** *(string) --* 

                The model package group name.

                
              

              - **ViolationReport** *(string) --* 

                The Amazon S3 URI of the violation report if violations are detected.

                
              

              - **CheckJobArn** *(string) --* 

                The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.

                
              

              - **SkipCheck** *(boolean) --* 

                This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to ``False``, the previous baseline of the configured check type must be available.

                
              

              - **RegisterNewBaseline** *(boolean) --* 

                This flag indicates if a newly calculated baseline can be accessed through step properties ``BaselineUsedForDriftCheckConstraints`` and ``BaselineUsedForDriftCheckStatistics``. If it is set to ``False``, the previous baseline of the configured check type must also be available. These can be accessed through the ``BaselineUsedForDriftCheckConstraints`` property.

                
          
            

            - **Fail** *(dict) --* 

              The configurations and outcomes of a Fail step execution.

              
              

              - **ErrorMessage** *(string) --* 

                A message that you define and then is processed and rendered by the Fail step when the error occurs.

                
          
            

            - **AutoMLJob** *(dict) --* 

              The Amazon Resource Name (ARN) of the AutoML job that was run by this step.

              
              

              - **Arn** *(string) --* 

                The Amazon Resource Name (ARN) of the AutoML job.

                
          
            

            - **Endpoint** *(dict) --* 

              The endpoint that was invoked during this step execution.

              
              

              - **Arn** *(string) --* 

                The Amazon Resource Name (ARN) of the endpoint in the step.

                
          
            

            - **EndpointConfig** *(dict) --* 

              The endpoint configuration used to create an endpoint during this step execution.

              
              

              - **Arn** *(string) --* 

                The Amazon Resource Name (ARN) of the endpoint configuration used in the step.

                
          
            

            - **BedrockCustomModel** *(dict) --* 

              The metadata of the Amazon Bedrock custom model used in the pipeline execution step.

              
              

              - **Arn** *(string) --* 

                The Amazon Resource Name (ARN) of the Amazon Bedrock custom model.

                
          
            

            - **BedrockCustomModelDeployment** *(dict) --* 

              The metadata of the Amazon Bedrock custom model deployment used in pipeline execution step.

              
              

              - **Arn** *(string) --* 

                The Amazon Resource Name (ARN) for the Amazon Bedrock custom model deployment.

                
          
            

            - **BedrockProvisionedModelThroughput** *(dict) --* 

              The metadata of the Amazon Bedrock provisioned model throughput used in the pipeline execution step.

              
              

              - **Arn** *(string) --* 

                The Amazon Resource Name (ARN) of the Amazon Bedrock provisioned model throughput.

                
          
            

            - **BedrockModelImport** *(dict) --* 

              The metadata of Amazon Bedrock model import used in pipeline execution step.

              
              

              - **Arn** *(string) --* 

                The Amazon Resource Name (ARN) of the Amazon Bedrock model import.

                
          
            

            - **InferenceComponent** *(dict) --* 

              The metadata of the inference component used in pipeline execution step.

              
              

              - **Arn** *(string) --* 

                The Amazon Resource Name (ARN) of the inference component.

                
          
            

            - **Lineage** *(dict) --* 

              The metadata of the lineage used in pipeline execution step.

              
              

              - **ActionArns** *(dict) --* 

                The Amazon Resource Name (ARN) of the lineage action.

                
                

                - *(string) --* 
                  

                  - *(string) --* 
            
          
              

              - **ArtifactArns** *(dict) --* 

                The Amazon Resource Name (ARN) of the lineage artifact.

                
                

                - *(string) --* 
                  

                  - *(string) --* 
            
          
              

              - **ContextArns** *(dict) --* 

                The Amazon Resource Name (ARN) of the lineage context.

                
                

                - *(string) --* 
                  

                  - *(string) --* 
            
          
              

              - **Associations** *(list) --* 

                The lineage associations.

                
                

                - *(dict) --* 

                  The data type used to describe the relationship between different sources.

                  
                  

                  - **SourceArn** *(string) --* 

                    The Amazon Resource Name (ARN) of the ``AssociationInfo`` source.

                    
                  

                  - **DestinationArn** *(string) --* 

                    The Amazon Resource Name (ARN) of the ``AssociationInfo`` destination.

                    
              
            
          
        
          

          - **AttemptCount** *(integer) --* 

            The current attempt of the execution step. For more information, see `Retry Policy for SageMaker Pipelines steps <https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-retry-policy.html>`__.

            
          

          - **SelectiveExecutionResult** *(dict) --* 

            The ARN from an execution of the current pipeline from which results are reused for this step.

            
            

            - **SourcePipelineExecutionArn** *(string) --* 

              The ARN from an execution of the current pipeline.

              
        
      
    
      

      - **NextToken** *(string) --* 

        If the result of the previous ``ListPipelineExecutionSteps`` request was truncated, the response includes a ``NextToken``. To retrieve the next set of pipeline execution steps, use the token in the next request.

        
  
  **Exceptions**
  
  *   :py:class:`SageMaker.Client.exceptions.ResourceNotFound`

  