1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package sagemaker
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/aws-sdk-go-v2/service/sagemaker/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12	"time"
13)
14
15// Describes the details of a pipeline.
16func (c *Client) DescribePipeline(ctx context.Context, params *DescribePipelineInput, optFns ...func(*Options)) (*DescribePipelineOutput, error) {
17	if params == nil {
18		params = &DescribePipelineInput{}
19	}
20
21	result, metadata, err := c.invokeOperation(ctx, "DescribePipeline", params, optFns, c.addOperationDescribePipelineMiddlewares)
22	if err != nil {
23		return nil, err
24	}
25
26	out := result.(*DescribePipelineOutput)
27	out.ResultMetadata = metadata
28	return out, nil
29}
30
31type DescribePipelineInput struct {
32
33	// The name of the pipeline to describe.
34	//
35	// This member is required.
36	PipelineName *string
37
38	noSmithyDocumentSerde
39}
40
41type DescribePipelineOutput struct {
42
43	// Information about the user who created or modified an experiment, trial, trial
44	// component, or project.
45	CreatedBy *types.UserContext
46
47	// The time when the pipeline was created.
48	CreationTime *time.Time
49
50	// Information about the user who created or modified an experiment, trial, trial
51	// component, or project.
52	LastModifiedBy *types.UserContext
53
54	// The time when the pipeline was last modified.
55	LastModifiedTime *time.Time
56
57	// The time when the pipeline was last run.
58	LastRunTime *time.Time
59
60	// The Amazon Resource Name (ARN) of the pipeline.
61	PipelineArn *string
62
63	// The JSON pipeline definition.
64	PipelineDefinition *string
65
66	// The description of the pipeline.
67	PipelineDescription *string
68
69	// The display name of the pipeline.
70	PipelineDisplayName *string
71
72	// The name of the pipeline.
73	PipelineName *string
74
75	// The status of the pipeline execution.
76	PipelineStatus types.PipelineStatus
77
78	// The Amazon Resource Name (ARN) that the pipeline uses to execute.
79	RoleArn *string
80
81	// Metadata pertaining to the operation's result.
82	ResultMetadata middleware.Metadata
83
84	noSmithyDocumentSerde
85}
86
87func (c *Client) addOperationDescribePipelineMiddlewares(stack *middleware.Stack, options Options) (err error) {
88	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribePipeline{}, middleware.After)
89	if err != nil {
90		return err
91	}
92	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribePipeline{}, middleware.After)
93	if err != nil {
94		return err
95	}
96	if err = addSetLoggerMiddleware(stack, options); err != nil {
97		return err
98	}
99	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
100		return err
101	}
102	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
103		return err
104	}
105	if err = addResolveEndpointMiddleware(stack, options); err != nil {
106		return err
107	}
108	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
109		return err
110	}
111	if err = addRetryMiddlewares(stack, options); err != nil {
112		return err
113	}
114	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
115		return err
116	}
117	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
118		return err
119	}
120	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
121		return err
122	}
123	if err = addClientUserAgent(stack); err != nil {
124		return err
125	}
126	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
127		return err
128	}
129	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
130		return err
131	}
132	if err = addOpDescribePipelineValidationMiddleware(stack); err != nil {
133		return err
134	}
135	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribePipeline(options.Region), middleware.Before); err != nil {
136		return err
137	}
138	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
139		return err
140	}
141	if err = addResponseErrorMiddleware(stack); err != nil {
142		return err
143	}
144	if err = addRequestResponseLogging(stack, options); err != nil {
145		return err
146	}
147	return nil
148}
149
150func newServiceMetadataMiddleware_opDescribePipeline(region string) *awsmiddleware.RegisterServiceMetadata {
151	return &awsmiddleware.RegisterServiceMetadata{
152		Region:        region,
153		ServiceID:     ServiceID,
154		SigningName:   "sagemaker",
155		OperationName: "DescribePipeline",
156	}
157}
158