SageMaker / Client / describe_pipeline_execution

describe_pipeline_execution¶

SageMaker.Client.describe_pipeline_execution(**kwargs)¶

Describes the details of a pipeline execution.

Request Syntax

response = client.describe_pipeline_execution(
    PipelineExecutionArn='string'
)

Parameters:

PipelineExecutionArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'PipelineArn': 'string',
    'PipelineExecutionArn': 'string',
    'PipelineExecutionDisplayName': 'string',
    'PipelineExecutionStatus': 'Executing'|'Stopping'|'Stopped'|'Failed'|'Succeeded',
    'PipelineExecutionDescription': 'string',
    'PipelineExperimentConfig': {
        'ExperimentName': 'string',
        'TrialName': 'string'
    },
    'FailureReason': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'CreatedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string',
        'IamIdentity': {
            'Arn': 'string',
            'PrincipalId': 'string',
            'SourceIdentity': 'string'
        }
    },
    'LastModifiedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string',
        'IamIdentity': {
            'Arn': 'string',
            'PrincipalId': 'string',
            'SourceIdentity': 'string'
        }
    },
    'ParallelismConfiguration': {
        'MaxParallelExecutionSteps': 123
    },
    'SelectiveExecutionConfig': {
        'SourcePipelineExecutionArn': 'string',
        'SelectedSteps': [
            {
                'StepName': 'string'
            },
        ]
    },
    'PipelineVersionId': 123
}

Response Structure

(dict) –
- PipelineArn (string) –
  
  The Amazon Resource Name (ARN) of the pipeline.
- PipelineExecutionArn (string) –
  
  The Amazon Resource Name (ARN) of the pipeline execution.
- PipelineExecutionDisplayName (string) –
  
  The display name of the pipeline execution.
- PipelineExecutionStatus (string) –
  
  The status of the pipeline execution.
- PipelineExecutionDescription (string) –
  
  The description of the pipeline execution.
- PipelineExperimentConfig (dict) –
  
  Specifies the names of the experiment and trial created by a pipeline.
  - ExperimentName (string) –
    
    The name of the experiment.
  - TrialName (string) –
    
    The name of the trial.
- FailureReason (string) –
  
  If the execution failed, a message describing why.
- CreationTime (datetime) –
  
  The time when the pipeline execution was created.
- LastModifiedTime (datetime) –
  
  The time when the pipeline execution was modified last.
- CreatedBy (dict) –
  
  Information about the user who created or modified a SageMaker resource.
  - UserProfileArn (string) –
    
    The Amazon Resource Name (ARN) of the user’s profile.
  - UserProfileName (string) –
    
    The name of the user’s profile.
  - DomainId (string) –
    
    The domain associated with the user.
  - IamIdentity (dict) –
    
    The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) of the IAM identity.
    - PrincipalId (string) –
      
      The ID of the principal that assumes the IAM identity.
    - SourceIdentity (string) –
      
      The person or application which assumes the IAM identity.
- LastModifiedBy (dict) –
  
  Information about the user who created or modified a SageMaker resource.
  - UserProfileArn (string) –
    
    The Amazon Resource Name (ARN) of the user’s profile.
  - UserProfileName (string) –
    
    The name of the user’s profile.
  - DomainId (string) –
    
    The domain associated with the user.
  - IamIdentity (dict) –
    
    The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) of the IAM identity.
    - PrincipalId (string) –
      
      The ID of the principal that assumes the IAM identity.
    - SourceIdentity (string) –
      
      The person or application which assumes the IAM identity.
- ParallelismConfiguration (dict) –
  
  The parallelism configuration applied to the pipeline.
  - MaxParallelExecutionSteps (integer) –
    
    The max number of steps that can be executed in parallel.
- SelectiveExecutionConfig (dict) –
  
  The selective execution configuration applied to the pipeline run.
  - SourcePipelineExecutionArn (string) –
    
    The ARN from a reference execution of the current pipeline. Used to copy input collaterals needed for the selected steps to run. The execution status of the pipeline can be either Failed or Success.
    
    This field is required if the steps you specify for SelectedSteps depend on output collaterals from any non-specified pipeline steps. For more information, see Selective Execution for Pipeline Steps.
  - SelectedSteps (list) –
    
    A list of pipeline steps to run. All step(s) in all path(s) between two selected steps should be included.
    - (dict) –
      
      A step selected to run in selective execution mode.
      - StepName (string) –
        
        The name of the pipeline step.
- PipelineVersionId (integer) –
  
  The ID of the pipeline version.

Exceptions

SageMaker.Client.exceptions.ResourceNotFound