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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package grafana
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"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 Amazon Web Services SSO, use UpdateWorkspaceAuthentication
// (https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspaceAuthentication.html).
// To modify which users in the workspace have the Admin and Editor Grafana roles,
// use UpdatePermissions
// (https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.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 name of an IAM role that already exists to use to access resources through
// Organizations.
OrganizationRoleName *string
// If you specify Service Managed, Amazon Managed Grafana automatically creates the
// IAM roles and provisions the permissions that the workspace needs to use Amazon
// Web Services data sources and notification channels. If you specify
// CUSTOMER_MANAGED, you will manage those roles and permissions yourself. If you
// are creating this workspace in a member 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. For more information, see 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)
PermissionType types.PermissionType
// The name of the CloudFormation stack set to use to generate IAM roles to be used
// for this workspace.
StackSetName *string
// Specify the Amazon Web Services data sources that you want to be queried in this
// workspace. Specifying these data sources here enables Amazon Managed Grafana to
// create IAM roles and permissions that allow Amazon Managed Grafana to read data
// from these sources. You must still add them as data sources in the Grafana
// console in the workspace. If you don't specify a data source here, you can still
// add it as a data source later in the workspace console. However, you will then
// have to manually configure permissions for it.
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
// The workspace needs an IAM role that grants permissions to the Amazon Web
// Services resources that the workspace will view data from. If you already have a
// role that you want to use, specify it here. If you omit this field and you
// specify some Amazon Web Services resources in workspaceDataSources or
// workspaceNotificationDestinations, a new IAM role with the necessary permissions
// is automatically created.
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) {
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 = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(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 = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateWorkspace(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "grafana",
OperationName: "UpdateWorkspace",
}
}
|
