-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_CreateDashboard.go
212 lines (184 loc) · 7.21 KB
/
api_op_CreateDashboard.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
// Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
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/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates a dashboard from a template. To first create a template, see the
// CreateTemplate
// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html)
// API operation. A dashboard is an entity in Amazon QuickSight that identifies
// Amazon QuickSight reports, created from analyses. You can share Amazon
// QuickSight dashboards. With the right permissions, you can create scheduled
// email reports from them. If you have the correct permissions, you can create a
// dashboard from a template that exists in a different Amazon Web Services
// account.
func (c *Client) CreateDashboard(ctx context.Context, params *CreateDashboardInput, optFns ...func(*Options)) (*CreateDashboardOutput, error) {
if params == nil {
params = &CreateDashboardInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateDashboard", params, optFns, c.addOperationCreateDashboardMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateDashboardOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateDashboardInput struct {
// The ID of the Amazon Web Services account where you want to create the
// dashboard.
//
// This member is required.
AwsAccountId *string
// The ID for the dashboard, also added to the IAM policy.
//
// This member is required.
DashboardId *string
// The display name of the dashboard.
//
// This member is required.
Name *string
// The entity that you are using as a source when you create the dashboard. In
// SourceEntity, you specify the type of object you're using as source. You can
// only create a dashboard from a template, so you use a SourceTemplate entity. If
// you need to create a dashboard from an analysis, first convert the analysis to a
// template by using the CreateTemplate
// (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html)
// API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the
// source template. The SourceTemplateARN can contain any Amazon Web Services
// account and any Amazon QuickSight-supported Amazon Web Services Region. Use the
// DataSetReferences entity within SourceTemplate to list the replacement datasets
// for the placeholders listed in the original. The schema in each dataset must
// match its placeholder.
//
// This member is required.
SourceEntity *types.DashboardSourceEntity
// Options for publishing the dashboard when you create it:
//
// * AvailabilityStatus
// for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When
// this is set to DISABLED, Amazon QuickSight disables the left filter pane on the
// published dashboard, which can be used for ad hoc (one-time) filtering. This
// option is ENABLED by default.
//
// * AvailabilityStatus for ExportToCSVOption - This
// status can be either ENABLED or DISABLED. The visual option to export data to
// .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED
// by default.
//
// * VisibilityState for SheetControlsOption - This visibility state
// can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
DashboardPublishOptions *types.DashboardPublishOptions
// The parameters for the creation of the dashboard, which you want to use to
// override the default settings. A dashboard can have any type of parameters, and
// some parameters might accept multiple values.
Parameters *types.Parameters
// A structure that contains the permissions of the dashboard. You can use this
// structure for granting permissions by providing a list of IAM action information
// for each principal ARN. To specify no permissions, omit the permissions list.
Permissions []types.ResourcePermission
// Contains a map of the key-value pairs for the resource tag or tags assigned to
// the dashboard.
Tags []types.Tag
// The Amazon Resource Name (ARN) of the theme that is being used for this
// dashboard. If you add a value for this field, it overrides the value that is
// used in the source entity. The theme ARN must exist in the same Amazon Web
// Services account where you create the dashboard.
ThemeArn *string
// A description for the first version of the dashboard being created.
VersionDescription *string
noSmithyDocumentSerde
}
type CreateDashboardOutput struct {
// The ARN of the dashboard.
Arn *string
// The status of the dashboard creation request.
CreationStatus types.ResourceStatus
// The ID for the dashboard.
DashboardId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The ARN of the dashboard, including the version number of the first version that
// is created.
VersionArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateDashboardMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpCreateDashboard{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreateDashboard{}, 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 = addOpCreateDashboardValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateDashboard(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_opCreateDashboard(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "CreateDashboard",
}
}