DescribePipeline
Describes the details of a pipeline.
Request Syntax
{
"PipelineName": "string",
"PipelineVersionAlias": "string",
"PipelineVersionId": number
}
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.
- PipelineName
-
The name or Amazon Resource Name (ARN) of the pipeline to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:([0-9]{12}|aws):pipeline/.*)?([a-zA-Z0-9](-*[a-zA-Z0-9]){0,255})Required: Yes
- PipelineVersionAlias
-
The alias of the pipeline version to describe. You can't specify this with
PipelineVersionId. If no version of the pipeline has this alias, the request fails with aResourceNotFounderror. If you specify neither, SageMaker describes the latest version of the pipeline.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9._\-]{1,128}Required: No
- PipelineVersionId
-
The ID of the pipeline version to describe. You can't specify this with
PipelineVersionAlias.Type: Long
Valid Range: Minimum value of 1.
Required: No
Response Syntax
{
"CreatedBy": {
"DomainId": "string",
"IamIdentity": {
"Arn": "string",
"PrincipalId": "string",
"SourceIdentity": "string"
},
"UserProfileArn": "string",
"UserProfileName": "string"
},
"CreationTime": number,
"LastModifiedBy": {
"DomainId": "string",
"IamIdentity": {
"Arn": "string",
"PrincipalId": "string",
"SourceIdentity": "string"
},
"UserProfileArn": "string",
"UserProfileName": "string"
},
"LastModifiedTime": number,
"LastRunTime": number,
"ParallelismConfiguration": {
"MaxParallelExecutionSteps": number
},
"PipelineArn": "string",
"PipelineDefinition": "string",
"PipelineDescription": "string",
"PipelineDisplayName": "string",
"PipelineName": "string",
"PipelineStatus": "string",
"PipelineVersionAliases": [ "string" ],
"PipelineVersionDescription": "string",
"PipelineVersionDisplayName": "string",
"RoleArn": "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.
- CreatedBy
-
Information about the user who created or modified a SageMaker resource.
Type: UserContext object
- CreationTime
-
The time when the pipeline was created.
Type: Timestamp
- LastModifiedBy
-
Information about the user who created or modified a SageMaker resource.
Type: UserContext object
- LastModifiedTime
-
The time when the pipeline was last modified.
Type: Timestamp
- LastRunTime
-
The time when the pipeline was last run.
Type: Timestamp
- ParallelismConfiguration
-
Lists the parallelism configuration applied to the pipeline.
Type: ParallelismConfiguration object
- PipelineArn
-
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/.* - PipelineDefinition
-
The JSON pipeline definition.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1048576.
Pattern:
.*(?:[ \r\n\t].*)* - PipelineDescription
-
The description of the pipeline.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 3072.
Pattern:
.* - PipelineDisplayName
-
The display name of the pipeline.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255} - PipelineName
-
The name of the pipeline.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255} - PipelineStatus
-
The status of the pipeline execution.
Type: String
Valid Values:
Active | Deleting - PipelineVersionAliases
-
The aliases assigned to the pipeline version.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9._\-]{1,128} - PipelineVersionDescription
-
The description of the pipeline version.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 3072.
Pattern:
.* - PipelineVersionDisplayName
-
The display name of the pipeline version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 82.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,81} - RoleArn
-
The Amazon Resource Name (ARN) that the pipeline uses to execute.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+
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 Amazon SDKs, see the following: