1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package qbusiness
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/qbusiness/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Gets information about an existing Amazon Q Business web experience.
func (c *Client) GetWebExperience(ctx context.Context, params *GetWebExperienceInput, optFns ...func(*Options)) (*GetWebExperienceOutput, error) {
if params == nil {
params = &GetWebExperienceInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetWebExperience", params, optFns, c.addOperationGetWebExperienceMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetWebExperienceOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetWebExperienceInput struct {
// The identifier of the Amazon Q Business application linked to the web
// experience.
//
// This member is required.
ApplicationId *string
// The identifier of the Amazon Q Business web experience.
//
// This member is required.
WebExperienceId *string
noSmithyDocumentSerde
}
type GetWebExperienceOutput struct {
// The identifier of the Amazon Q Business application linked to the web
// experience.
ApplicationId *string
// The authentication configuration information for your Amazon Q Business web
// experience.
//
// Deprecated: Property associated with legacy SAML IdP flow. Deprecated in favor
// of using AWS IAM Identity Center for user management.
AuthenticationConfiguration types.WebExperienceAuthConfiguration
// The Unix timestamp when the Amazon Q Business web experience was last created.
CreatedAt *time.Time
// The endpoint of your Amazon Q Business web experience.
DefaultEndpoint *string
// When the Status field value is FAILED , the ErrorMessage field contains a
// description of the error that caused the data source connector to fail.
Error *types.ErrorDetail
// The Amazon Resource Name (ARN) of the service role attached to your web
// experience.
RoleArn *string
// Determines whether sample prompts are enabled in the web experience for an end
// user.
SamplePromptsControlMode types.WebExperienceSamplePromptsControlMode
// The current status of the Amazon Q Business web experience. When the Status
// field value is FAILED , the ErrorMessage field contains a description of the
// error that caused the data source connector to fail.
Status types.WebExperienceStatus
// The subtitle for your Amazon Q Business web experience.
Subtitle *string
// The title for your Amazon Q Business web experience.
Title *string
// The Unix timestamp when the Amazon Q Business web experience was last updated.
UpdatedAt *time.Time
// The Amazon Resource Name (ARN) of the role with the permission to access the
// Amazon Q Business web experience and required resources.
WebExperienceArn *string
// The identifier of the Amazon Q Business web experience.
WebExperienceId *string
// The customized welcome message for end users of an Amazon Q Business web
// experience.
WelcomeMessage *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetWebExperienceMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetWebExperience{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetWebExperience{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetWebExperience"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpGetWebExperienceValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetWebExperience(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opGetWebExperience(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetWebExperience",
}
}
|
