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// Provides a list of an experiment's properties.
16func (c *Client) DescribeExperiment(ctx context.Context, params *DescribeExperimentInput, optFns ...func(*Options)) (*DescribeExperimentOutput, error) {
17	if params == nil {
18		params = &DescribeExperimentInput{}
19	}
20
21	result, metadata, err := c.invokeOperation(ctx, "DescribeExperiment", params, optFns, c.addOperationDescribeExperimentMiddlewares)
22	if err != nil {
23		return nil, err
24	}
25
26	out := result.(*DescribeExperimentOutput)
27	out.ResultMetadata = metadata
28	return out, nil
29}
30
31type DescribeExperimentInput struct {
32
33	// The name of the experiment to describe.
34	//
35	// This member is required.
36	ExperimentName *string
37
38	noSmithyDocumentSerde
39}
40
41type DescribeExperimentOutput struct {
42
43	// Who created the experiment.
44	CreatedBy *types.UserContext
45
46	// When the experiment was created.
47	CreationTime *time.Time
48
49	// The description of the experiment.
50	Description *string
51
52	// The name of the experiment as displayed. If DisplayName isn't specified,
53	// ExperimentName is displayed.
54	DisplayName *string
55
56	// The Amazon Resource Name (ARN) of the experiment.
57	ExperimentArn *string
58
59	// The name of the experiment.
60	ExperimentName *string
61
62	// Who last modified the experiment.
63	LastModifiedBy *types.UserContext
64
65	// When the experiment was last modified.
66	LastModifiedTime *time.Time
67
68	// The ARN of the source and, optionally, the type.
69	Source *types.ExperimentSource
70
71	// Metadata pertaining to the operation's result.
72	ResultMetadata middleware.Metadata
73
74	noSmithyDocumentSerde
75}
76
77func (c *Client) addOperationDescribeExperimentMiddlewares(stack *middleware.Stack, options Options) (err error) {
78	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeExperiment{}, middleware.After)
79	if err != nil {
80		return err
81	}
82	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeExperiment{}, middleware.After)
83	if err != nil {
84		return err
85	}
86	if err = addSetLoggerMiddleware(stack, options); err != nil {
87		return err
88	}
89	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
90		return err
91	}
92	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
93		return err
94	}
95	if err = addResolveEndpointMiddleware(stack, options); err != nil {
96		return err
97	}
98	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
99		return err
100	}
101	if err = addRetryMiddlewares(stack, options); err != nil {
102		return err
103	}
104	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
105		return err
106	}
107	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
108		return err
109	}
110	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
111		return err
112	}
113	if err = addClientUserAgent(stack); err != nil {
114		return err
115	}
116	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
117		return err
118	}
119	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
120		return err
121	}
122	if err = addOpDescribeExperimentValidationMiddleware(stack); err != nil {
123		return err
124	}
125	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeExperiment(options.Region), middleware.Before); err != nil {
126		return err
127	}
128	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
129		return err
130	}
131	if err = addResponseErrorMiddleware(stack); err != nil {
132		return err
133	}
134	if err = addRequestResponseLogging(stack, options); err != nil {
135		return err
136	}
137	return nil
138}
139
140func newServiceMetadataMiddleware_opDescribeExperiment(region string) *awsmiddleware.RegisterServiceMetadata {
141	return &awsmiddleware.RegisterServiceMetadata{
142		Region:        region,
143		ServiceID:     ServiceID,
144		SigningName:   "sagemaker",
145		OperationName: "DescribeExperiment",
146	}
147}
148