/
api_op_UpdateWorkspace.go
247 lines (218 loc) · 9.1 KB
/
api_op_UpdateWorkspace.go
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
// Code generated by smithy-go-codegen DO NOT EDIT.
package grafana
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/grafana/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Modifies an existing Amazon Managed Grafana workspace. If you use this
// operation and omit any optional parameters, the existing values of those
// parameters are not changed.
//
// To modify the user authentication methods that the workspace uses, such as SAML
// or IAM Identity Center, use [UpdateWorkspaceAuthentication].
//
// To modify which users in the workspace have the Admin and Editor Grafana roles,
// use [UpdatePermissions].
//
// [UpdatePermissions]: https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html
// [UpdateWorkspaceAuthentication]: https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspaceAuthentication.html
func (c *Client) UpdateWorkspace(ctx context.Context, params *UpdateWorkspaceInput, optFns ...func(*Options)) (*UpdateWorkspaceOutput, error) {
if params == nil {
params = &UpdateWorkspaceInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateWorkspace", params, optFns, c.addOperationUpdateWorkspaceMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateWorkspaceOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateWorkspaceInput struct {
// The ID of the workspace to update.
//
// This member is required.
WorkspaceId *string
// Specifies whether the workspace can access Amazon Web Services resources in
// this Amazon Web Services account only, or whether it can also access Amazon Web
// Services resources in other accounts in the same organization. If you specify
// ORGANIZATION , you must specify which organizational units the workspace can
// access in the workspaceOrganizationalUnits parameter.
AccountAccessType types.AccountAccessType
// The configuration settings for network access to your workspace.
//
// When this is configured, only listed IP addresses and VPC endpoints will be
// able to access your workspace. Standard Grafana authentication and authorization
// will still be required.
//
// If this is not configured, or is removed, then all IP addresses and VPC
// endpoints will be allowed. Standard Grafana authentication and authorization
// will still be required.
NetworkAccessControl *types.NetworkAccessConfiguration
// The name of an IAM role that already exists to use to access resources through
// Organizations. This can only be used with a workspace that has the
// permissionType set to CUSTOMER_MANAGED .
OrganizationRoleName *string
// Use this parameter if you want to change a workspace from SERVICE_MANAGED to
// CUSTOMER_MANAGED . This allows you to manage the permissions that the workspace
// uses to access datasources and notification channels. If the workspace is in a
// member Amazon Web Services account of an organization, and that account is not a
// delegated administrator account, and you want the workspace to access data
// sources in other Amazon Web Services accounts in the organization, you must
// choose CUSTOMER_MANAGED .
//
// If you specify this as CUSTOMER_MANAGED , you must also specify a
// workspaceRoleArn that the workspace will use for accessing Amazon Web Services
// resources.
//
// For more information on the role and permissions needed, see [Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels]
//
// Do not use this to convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED . Do
// not include this parameter if you want to leave the workspace as SERVICE_MANAGED
// .
//
// You can convert a CUSTOMER_MANAGED workspace to SERVICE_MANAGED using the
// Amazon Managed Grafana console. For more information, see [Managing permissions for data sources and notification channels].
//
// [Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels]: https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html
// [Managing permissions for data sources and notification channels]: https://docs.aws.amazon.com/grafana/latest/userguide/AMG-datasource-and-notification.html
PermissionType types.PermissionType
// Whether to remove the network access configuration from the workspace.
//
// Setting this to true and providing a networkAccessControl to set will return an
// error.
//
// If you remove this configuration by setting this to true , then all IP addresses
// and VPC endpoints will be allowed. Standard Grafana authentication and
// authorization will still be required.
RemoveNetworkAccessConfiguration *bool
// Whether to remove the VPC configuration from the workspace.
//
// Setting this to true and providing a vpcConfiguration to set will return an
// error.
RemoveVpcConfiguration *bool
// The name of the CloudFormation stack set to use to generate IAM roles to be
// used for this workspace.
StackSetName *string
// The configuration settings for an Amazon VPC that contains data sources for
// your Grafana workspace to connect to.
VpcConfiguration *types.VpcConfiguration
// This parameter is for internal use only, and should not be used.
WorkspaceDataSources []types.DataSourceType
// A description for the workspace. This is used only to help you identify this
// workspace.
WorkspaceDescription *string
// A new name for the workspace to update.
WorkspaceName *string
// Specify the Amazon Web Services notification channels that you plan to use in
// this workspace. Specifying these data sources here enables Amazon Managed
// Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to
// use these channels.
WorkspaceNotificationDestinations []types.NotificationDestinationType
// Specifies the organizational units that this workspace is allowed to use data
// sources from, if this workspace is in an account that is part of an
// organization.
WorkspaceOrganizationalUnits []string
// Specifies an IAM role that grants permissions to Amazon Web Services resources
// that the workspace accesses, such as data sources and notification channels. If
// this workspace has permissionType CUSTOMER_MANAGED , then this role is required.
WorkspaceRoleArn *string
noSmithyDocumentSerde
}
type UpdateWorkspaceOutput struct {
// A structure containing data about the workspace that was created.
//
// This member is required.
Workspace *types.WorkspaceDescription
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateWorkspaceMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateWorkspace{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateWorkspace{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "UpdateWorkspace"); 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 = addOpUpdateWorkspaceValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateWorkspace(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_opUpdateWorkspace(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "UpdateWorkspace",
}
}