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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
"fmt"
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"
)
// Provides a detailed description of the definition of a dashboard. If you do not
// need to know details about the content of a dashboard, for instance if you are
// trying to check the status of a recently created or updated dashboard, use the
// DescribeDashboard (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboard.html)
// instead.
func (c *Client) DescribeDashboardDefinition(ctx context.Context, params *DescribeDashboardDefinitionInput, optFns ...func(*Options)) (*DescribeDashboardDefinitionOutput, error) {
if params == nil {
params = &DescribeDashboardDefinitionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeDashboardDefinition", params, optFns, c.addOperationDescribeDashboardDefinitionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeDashboardDefinitionOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeDashboardDefinitionInput struct {
// The ID of the Amazon Web Services account that contains the dashboard that
// you're describing.
//
// This member is required.
AwsAccountId *string
// The ID for the dashboard.
//
// This member is required.
DashboardId *string
// The alias name.
AliasName *string
// The version number for the dashboard. If a version number isn't passed, the
// latest published dashboard version is described.
VersionNumber *int64
noSmithyDocumentSerde
}
type DescribeDashboardDefinitionOutput struct {
// The ID of the dashboard described.
DashboardId *string
// Options for publishing the dashboard:
// - 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 definition of a dashboard. A definition is the data model of all features
// in a Dashboard, Template, or Analysis.
Definition *types.DashboardVersionDefinition
// Errors associated with this dashboard version.
Errors []types.DashboardError
// The display name of the dashboard.
Name *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// Status associated with the dashboard version.
// - CREATION_IN_PROGRESS
// - CREATION_SUCCESSFUL
// - CREATION_FAILED
// - UPDATE_IN_PROGRESS
// - UPDATE_SUCCESSFUL
// - UPDATE_FAILED
// - DELETED
ResourceStatus types.ResourceStatus
// The HTTP status of the request.
Status int32
// The ARN of the theme of the dashboard.
ThemeArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeDashboardDefinitionMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpDescribeDashboardDefinition{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDescribeDashboardDefinition{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeDashboardDefinition"); 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 = 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 = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.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 = addOpDescribeDashboardDefinitionValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeDashboardDefinition(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.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_opDescribeDashboardDefinition(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DescribeDashboardDefinition",
}
}
|
