Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

describe_pipeline_execution

describe_pipeline_execution(**kwargs)

Describes the details of a pipeline execution.

See also: AWS API Documentation

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'
    },
    'LastModifiedBy': {
        'UserProfileArn': 'string',
        'UserProfileName': 'string',
        'DomainId': 'string'
    },
    'ParallelismConfiguration': {
        'MaxParallelExecutionSteps': 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 an experiment, trial, trial component, lineage group, project, or model card.

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

    • LastModifiedBy (dict) --

      Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

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

    • ParallelismConfiguration (dict) --

      The parallelism configuration applied to the pipeline.

      • MaxParallelExecutionSteps (integer) --

        The max number of steps that can be executed in parallel.

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound