describe-pipeline-execution¶
Description¶
Describes the details of a pipeline execution.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-pipeline-execution
--pipeline-execution-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--pipeline-execution-arn (string)
The Amazon Resource Name (ARN) of the pipeline execution.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Output¶
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 -> (structure)
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 -> (timestamp)
The time when the pipeline execution was created.
LastModifiedTime -> (timestamp)
The time when the pipeline execution was modified last.
CreatedBy -> (structure)
Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
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 -> (structure)
Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
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 -> (structure)
The parallelism configuration applied to the pipeline.
MaxParallelExecutionSteps -> (integer)
The max number of steps that can be executed in parallel.