DescribePipeline - Amazon SageMaker

DescribePipeline

Describes the details of a pipeline.

Request Syntax

{ "PipelineName": "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.

PipelineName

The name of the pipeline to describe.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,255}

Required: Yes

Response Syntax

{ "CreatedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "CreationTime": number, "LastModifiedBy": { "DomainId": "string", "UserProfileArn": "string", "UserProfileName": "string" }, "LastModifiedTime": number, "LastRunTime": number, "PipelineArn": "string", "PipelineDefinition": "string", "PipelineDescription": "string", "PipelineDisplayName": "string", "PipelineName": "string", "PipelineStatus": "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 an experiment, trial, or trial component.

Type: UserContext object

CreationTime

The time when the pipeline was created.

Type: Timestamp

LastModifiedBy

Information about the user who created or modified an experiment, trial, or trial component.

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

PipelineArn

The Amazon Resource Name (ARN) of the pipeline.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}: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

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

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: