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// Returns a description of a model explainability job definition.
16func (c *Client) DescribeModelExplainabilityJobDefinition(ctx context.Context, params *DescribeModelExplainabilityJobDefinitionInput, optFns ...func(*Options)) (*DescribeModelExplainabilityJobDefinitionOutput, error) {
17	if params == nil {
18		params = &DescribeModelExplainabilityJobDefinitionInput{}
19	}
20
21	result, metadata, err := c.invokeOperation(ctx, "DescribeModelExplainabilityJobDefinition", params, optFns, addOperationDescribeModelExplainabilityJobDefinitionMiddlewares)
22	if err != nil {
23		return nil, err
24	}
25
26	out := result.(*DescribeModelExplainabilityJobDefinitionOutput)
27	out.ResultMetadata = metadata
28	return out, nil
29}
30
31type DescribeModelExplainabilityJobDefinitionInput struct {
32
33	// The name of the model explainability job definition. The name must be unique
34	// within an AWS Region in the AWS account.
35	//
36	// This member is required.
37	JobDefinitionName *string
38}
39
40type DescribeModelExplainabilityJobDefinitionOutput struct {
41
42	// The time at which the model explainability job was created.
43	//
44	// This member is required.
45	CreationTime *time.Time
46
47	// The Amazon Resource Name (ARN) of the model explainability job.
48	//
49	// This member is required.
50	JobDefinitionArn *string
51
52	// The name of the explainability job definition. The name must be unique within an
53	// AWS Region in the AWS account.
54	//
55	// This member is required.
56	JobDefinitionName *string
57
58	// Identifies the resources to deploy for a monitoring job.
59	//
60	// This member is required.
61	JobResources *types.MonitoringResources
62
63	// Configures the model explainability job to run a specified Docker container
64	// image.
65	//
66	// This member is required.
67	ModelExplainabilityAppSpecification *types.ModelExplainabilityAppSpecification
68
69	// Inputs for the model explainability job.
70	//
71	// This member is required.
72	ModelExplainabilityJobInput *types.ModelExplainabilityJobInput
73
74	// The output configuration for monitoring jobs.
75	//
76	// This member is required.
77	ModelExplainabilityJobOutputConfig *types.MonitoringOutputConfig
78
79	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM)
80	// role that has read permission to the input data location and write permission to
81	// the output data location in Amazon S3.
82	//
83	// This member is required.
84	RoleArn *string
85
86	// The baseline configuration for a model explainability job.
87	ModelExplainabilityBaselineConfig *types.ModelExplainabilityBaselineConfig
88
89	// Networking options for a model explainability job.
90	NetworkConfig *types.MonitoringNetworkConfig
91
92	// A time limit for how long the monitoring job is allowed to run before stopping.
93	StoppingCondition *types.MonitoringStoppingCondition
94
95	// Metadata pertaining to the operation's result.
96	ResultMetadata middleware.Metadata
97}
98
99func addOperationDescribeModelExplainabilityJobDefinitionMiddlewares(stack *middleware.Stack, options Options) (err error) {
100	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeModelExplainabilityJobDefinition{}, middleware.After)
101	if err != nil {
102		return err
103	}
104	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeModelExplainabilityJobDefinition{}, middleware.After)
105	if err != nil {
106		return err
107	}
108	if err = addSetLoggerMiddleware(stack, options); err != nil {
109		return err
110	}
111	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
112		return err
113	}
114	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
115		return err
116	}
117	if err = addResolveEndpointMiddleware(stack, options); err != nil {
118		return err
119	}
120	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
121		return err
122	}
123	if err = addRetryMiddlewares(stack, options); err != nil {
124		return err
125	}
126	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
127		return err
128	}
129	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
130		return err
131	}
132	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
133		return err
134	}
135	if err = addClientUserAgent(stack); err != nil {
136		return err
137	}
138	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
139		return err
140	}
141	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
142		return err
143	}
144	if err = addOpDescribeModelExplainabilityJobDefinitionValidationMiddleware(stack); err != nil {
145		return err
146	}
147	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeModelExplainabilityJobDefinition(options.Region), middleware.Before); err != nil {
148		return err
149	}
150	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
151		return err
152	}
153	if err = addResponseErrorMiddleware(stack); err != nil {
154		return err
155	}
156	if err = addRequestResponseLogging(stack, options); err != nil {
157		return err
158	}
159	return nil
160}
161
162func newServiceMetadataMiddleware_opDescribeModelExplainabilityJobDefinition(region string) *awsmiddleware.RegisterServiceMetadata {
163	return &awsmiddleware.RegisterServiceMetadata{
164		Region:        region,
165		ServiceID:     ServiceID,
166		SigningName:   "sagemaker",
167		OperationName: "DescribeModelExplainabilityJobDefinition",
168	}
169}
170