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, 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
39type DescribePipelineOutput struct {
40
41	// Information about the user who created or modified an experiment, trial, or
42	// trial component.
43	CreatedBy *types.UserContext
44
45	// The time when the pipeline was created.
46	CreationTime *time.Time
47
48	// Information about the user who created or modified an experiment, trial, or
49	// trial component.
50	LastModifiedBy *types.UserContext
51
52	// The time when the pipeline was last modified.
53	LastModifiedTime *time.Time
54
55	// The time when the pipeline was last run.
56	LastRunTime *time.Time
57
58	// The Amazon Resource Name (ARN) of the pipeline.
59	PipelineArn *string
60
61	// The JSON pipeline definition.
62	PipelineDefinition *string
63
64	// The description of the pipeline.
65	PipelineDescription *string
66
67	// The display name of the pipeline.
68	PipelineDisplayName *string
69
70	// The name of the pipeline.
71	PipelineName *string
72
73	// The status of the pipeline execution.
74	PipelineStatus types.PipelineStatus
75
76	// The Amazon Resource Name (ARN) that the pipeline uses to execute.
77	RoleArn *string
78
79	// Metadata pertaining to the operation's result.
80	ResultMetadata middleware.Metadata
81}
82
83func addOperationDescribePipelineMiddlewares(stack *middleware.Stack, options Options) (err error) {
84	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribePipeline{}, middleware.After)
85	if err != nil {
86		return err
87	}
88	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribePipeline{}, middleware.After)
89	if err != nil {
90		return err
91	}
92	if err = addSetLoggerMiddleware(stack, options); err != nil {
93		return err
94	}
95	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
96		return err
97	}
98	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
99		return err
100	}
101	if err = addResolveEndpointMiddleware(stack, options); err != nil {
102		return err
103	}
104	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
105		return err
106	}
107	if err = addRetryMiddlewares(stack, options); err != nil {
108		return err
109	}
110	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
111		return err
112	}
113	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
114		return err
115	}
116	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
117		return err
118	}
119	if err = addClientUserAgent(stack); err != nil {
120		return err
121	}
122	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
123		return err
124	}
125	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
126		return err
127	}
128	if err = addOpDescribePipelineValidationMiddleware(stack); err != nil {
129		return err
130	}
131	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribePipeline(options.Region), middleware.Before); err != nil {
132		return err
133	}
134	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
135		return err
136	}
137	if err = addResponseErrorMiddleware(stack); err != nil {
138		return err
139	}
140	if err = addRequestResponseLogging(stack, options); err != nil {
141		return err
142	}
143	return nil
144}
145
146func newServiceMetadataMiddleware_opDescribePipeline(region string) *awsmiddleware.RegisterServiceMetadata {
147	return &awsmiddleware.RegisterServiceMetadata{
148		Region:        region,
149		ServiceID:     ServiceID,
150		SigningName:   "sagemaker",
151		OperationName: "DescribePipeline",
152	}
153}
154