1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package iotdeviceadvisor
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/iotdeviceadvisor/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12	"time"
13)
14
15// Gets information about a Device Advisor test suite run.
16func (c *Client) GetSuiteRun(ctx context.Context, params *GetSuiteRunInput, optFns ...func(*Options)) (*GetSuiteRunOutput, error) {
17	if params == nil {
18		params = &GetSuiteRunInput{}
19	}
20
21	result, metadata, err := c.invokeOperation(ctx, "GetSuiteRun", params, optFns, addOperationGetSuiteRunMiddlewares)
22	if err != nil {
23		return nil, err
24	}
25
26	out := result.(*GetSuiteRunOutput)
27	out.ResultMetadata = metadata
28	return out, nil
29}
30
31type GetSuiteRunInput struct {
32
33	// Requests the information about Device Advisor test suite run based on suite
34	// definition Id.
35	//
36	// This member is required.
37	SuiteDefinitionId *string
38
39	// Requests the information about Device Advisor test suite run based on suite run
40	// Id.
41	//
42	// This member is required.
43	SuiteRunId *string
44}
45
46type GetSuiteRunOutput struct {
47
48	// Gets the information about Device Advisor test suite run based on end time.
49	EndTime *time.Time
50
51	// Gets the information about Device Advisor test suite run based on error.
52	ErrorReason *string
53
54	// Gets the information about Device Advisor test suite run based on start time.
55	StartTime *time.Time
56
57	// Gets the information about Device Advisor test suite run based on its status.
58	Status types.SuiteRunStatus
59
60	// Gets the information about Device Advisor test suite run based on suite
61	// definition Id.
62	SuiteDefinitionId *string
63
64	// Gets the information about Device Advisor test suite run based on suite
65	// definition version.
66	SuiteDefinitionVersion *string
67
68	// The ARN of the suite run.
69	SuiteRunArn *string
70
71	// Gets the information about Device Advisor test suite run based on suite
72	// configuration.
73	SuiteRunConfiguration *types.SuiteRunConfiguration
74
75	// Gets the information about Device Advisor test suite run based on suite run Id.
76	SuiteRunId *string
77
78	// The tags attached to the suite run.
79	Tags map[string]string
80
81	// Gets the information about Device Advisor test suite run based on test case
82	// runs.
83	TestResult *types.TestResult
84
85	// Metadata pertaining to the operation's result.
86	ResultMetadata middleware.Metadata
87}
88
89func addOperationGetSuiteRunMiddlewares(stack *middleware.Stack, options Options) (err error) {
90	err = stack.Serialize.Add(&awsRestjson1_serializeOpGetSuiteRun{}, middleware.After)
91	if err != nil {
92		return err
93	}
94	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetSuiteRun{}, middleware.After)
95	if err != nil {
96		return err
97	}
98	if err = addSetLoggerMiddleware(stack, options); err != nil {
99		return err
100	}
101	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
102		return err
103	}
104	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
105		return err
106	}
107	if err = addResolveEndpointMiddleware(stack, options); err != nil {
108		return err
109	}
110	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
111		return err
112	}
113	if err = addRetryMiddlewares(stack, options); err != nil {
114		return err
115	}
116	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
117		return err
118	}
119	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
120		return err
121	}
122	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
123		return err
124	}
125	if err = addClientUserAgent(stack); err != nil {
126		return err
127	}
128	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
129		return err
130	}
131	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
132		return err
133	}
134	if err = addOpGetSuiteRunValidationMiddleware(stack); err != nil {
135		return err
136	}
137	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetSuiteRun(options.Region), middleware.Before); err != nil {
138		return err
139	}
140	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
141		return err
142	}
143	if err = addResponseErrorMiddleware(stack); err != nil {
144		return err
145	}
146	if err = addRequestResponseLogging(stack, options); err != nil {
147		return err
148	}
149	return nil
150}
151
152func newServiceMetadataMiddleware_opGetSuiteRun(region string) *awsmiddleware.RegisterServiceMetadata {
153	return &awsmiddleware.RegisterServiceMetadata{
154		Region:        region,
155		ServiceID:     ServiceID,
156		SigningName:   "iotdeviceadvisor",
157		OperationName: "GetSuiteRun",
158	}
159}
160