DescribePipelineExecutionCommand

Suggest an Edit

Describes the details of a pipeline execution.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SageMakerClient, DescribePipelineExecutionCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import
// const { SageMakerClient, DescribePipelineExecutionCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import
const client = new SageMakerClient(config);
const input = { // DescribePipelineExecutionRequest
  PipelineExecutionArn: "STRING_VALUE", // required
};
const command = new DescribePipelineExecutionCommand(input);
const response = await client.send(command);
// { // DescribePipelineExecutionResponse
//   PipelineArn: "STRING_VALUE",
//   PipelineExecutionArn: "STRING_VALUE",
//   PipelineExecutionDisplayName: "STRING_VALUE",
//   PipelineExecutionStatus: "Executing" || "Stopping" || "Stopped" || "Failed" || "Succeeded",
//   PipelineExecutionDescription: "STRING_VALUE",
//   PipelineExperimentConfig: { // PipelineExperimentConfig
//     ExperimentName: "STRING_VALUE",
//     TrialName: "STRING_VALUE",
//   },
//   FailureReason: "STRING_VALUE",
//   CreationTime: new Date("TIMESTAMP"),
//   LastModifiedTime: new Date("TIMESTAMP"),
//   CreatedBy: { // UserContext
//     UserProfileArn: "STRING_VALUE",
//     UserProfileName: "STRING_VALUE",
//     DomainId: "STRING_VALUE",
//     IamIdentity: { // IamIdentity
//       Arn: "STRING_VALUE",
//       PrincipalId: "STRING_VALUE",
//       SourceIdentity: "STRING_VALUE",
//     },
//   },
//   LastModifiedBy: {
//     UserProfileArn: "STRING_VALUE",
//     UserProfileName: "STRING_VALUE",
//     DomainId: "STRING_VALUE",
//     IamIdentity: {
//       Arn: "STRING_VALUE",
//       PrincipalId: "STRING_VALUE",
//       SourceIdentity: "STRING_VALUE",
//     },
//   },
//   ParallelismConfiguration: { // ParallelismConfiguration
//     MaxParallelExecutionSteps: Number("int"), // required
//   },
//   SelectiveExecutionConfig: { // SelectiveExecutionConfig
//     SourcePipelineExecutionArn: "STRING_VALUE",
//     SelectedSteps: [ // SelectedStepList // required
//       { // SelectedStep
//         StepName: "STRING_VALUE", // required
//       },
//     ],
//   },
// };

DescribePipelineExecutionCommand Input

See DescribePipelineExecutionCommandInput for more details

Parameter
Type
Description
PipelineExecutionArn
Required
string | undefined

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

DescribePipelineExecutionCommand Output

See DescribePipelineExecutionCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CreatedBy
UserContext | undefined

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

CreationTime
Date | undefined

The time when the pipeline execution was created.

FailureReason
string | undefined

If the execution failed, a message describing why.

LastModifiedBy
UserContext | undefined

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

LastModifiedTime
Date | undefined

The time when the pipeline execution was modified last.

ParallelismConfiguration
ParallelismConfiguration | undefined

The parallelism configuration applied to the pipeline.

PipelineArn
string | undefined

The Amazon Resource Name (ARN) of the pipeline.

PipelineExecutionArn
string | undefined

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

PipelineExecutionDescription
string | undefined

The description of the pipeline execution.

PipelineExecutionDisplayName
string | undefined

The display name of the pipeline execution.

PipelineExecutionStatus
PipelineExecutionStatus | undefined

The status of the pipeline execution.

PipelineExperimentConfig
PipelineExperimentConfig | undefined

Specifies the names of the experiment and trial created by a pipeline.

SelectiveExecutionConfig
SelectiveExecutionConfig | undefined

The selective execution configuration applied to the pipeline run.

Throws

Name
Fault
Details
ResourceNotFound
client

Resource being access is not found.

SageMakerServiceException
Base exception class for all service exceptions from SageMaker service.