DescribePipelineExecution - Amazon SageMaker (original) (raw)
Describes the details of a pipeline execution.
Request Syntax
{
"PipelineExecutionArn": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
The Amazon Resource Name (ARN) of the pipeline execution.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*
Required: Yes
Response Syntax
{
"CreatedBy": {
"DomainId": "string",
"IamIdentity": {
"Arn": "string",
"PrincipalId": "string",
"SourceIdentity": "string"
},
"UserProfileArn": "string",
"UserProfileName": "string"
},
"CreationTime": number,
"FailureReason": "string",
"LastModifiedBy": {
"DomainId": "string",
"IamIdentity": {
"Arn": "string",
"PrincipalId": "string",
"SourceIdentity": "string"
},
"UserProfileArn": "string",
"UserProfileName": "string"
},
"LastModifiedTime": number,
"MLflowConfig": {
"MlflowExperimentName": "string",
"MlflowResourceArn": "string"
},
"ParallelismConfiguration": {
"MaxParallelExecutionSteps": number
},
"PipelineArn": "string",
"PipelineExecutionArn": "string",
"PipelineExecutionDescription": "string",
"PipelineExecutionDisplayName": "string",
"PipelineExecutionStatus": "string",
"PipelineExperimentConfig": {
"ExperimentName": "string",
"TrialName": "string"
},
"PipelineVersionId": number,
"SelectiveExecutionConfig": {
"SelectedSteps": [
{
"StepName": "string"
}
],
"SourcePipelineExecutionArn": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Information about the user who created or modified a SageMaker resource.
Type: UserContext object
The time when the pipeline execution was created.
Type: Timestamp
If the execution failed, a message describing why.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1300.
Pattern: .*
Information about the user who created or modified a SageMaker resource.
Type: UserContext object
The time when the pipeline execution was modified last.
Type: Timestamp
The MLflow configuration of the pipeline execution.
Type: MLflowConfiguration object
The parallelism configuration applied to the pipeline.
Type: ParallelismConfiguration object
The Amazon Resource Name (ARN) of the pipeline.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:([0-9]{12}|aws):pipeline/.*
The Amazon Resource Name (ARN) of the pipeline execution.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:pipeline\/.*\/execution\/.*
The description of the pipeline execution.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 3072.
Pattern: .*
The display name of the pipeline execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 82.
Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,81}
The status of the pipeline execution.
Type: String
Valid Values: Executing | Stopping | Stopped | Failed | Succeeded
Specifies the names of the experiment and trial created by a pipeline.
Type: PipelineExperimentConfig object
The ID of the pipeline version.
Type: Long
Valid Range: Minimum value of 1.
The selective execution configuration applied to the pipeline run.
Type: SelectiveExecutionConfig object
Errors
For information about the errors that are common to all actions, see Common Error Types.
ResourceNotFound
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: