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
|
// 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 template. If you do not
// need to know details about the content of a template, for instance if you are
// trying to check the status of a recently created or updated template, use the
// DescribeTemplate (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeTemplate.html)
// instead.
func (c *Client) DescribeTemplateDefinition(ctx context.Context, params *DescribeTemplateDefinitionInput, optFns ...func(*Options)) (*DescribeTemplateDefinitionOutput, error) {
if params == nil {
params = &DescribeTemplateDefinitionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeTemplateDefinition", params, optFns, c.addOperationDescribeTemplateDefinitionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeTemplateDefinitionOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeTemplateDefinitionInput struct {
// The ID of the Amazon Web Services account that contains the template. You must
// be using the Amazon Web Services account that the template is in.
//
// This member is required.
AwsAccountId *string
// The ID of the template that you're describing.
//
// This member is required.
TemplateId *string
// The alias of the template that you want to describe. If you name a specific
// alias, you describe the version that the alias points to. You can specify the
// latest version of the template by providing the keyword $LATEST in the AliasName
// parameter. The keyword $PUBLISHED doesn't apply to templates.
AliasName *string
// The version number of the template.
VersionNumber *int64
noSmithyDocumentSerde
}
type DescribeTemplateDefinitionOutput struct {
// The definition of the template. A definition is the data model of all features
// in a Dashboard, Template, or Analysis.
Definition *types.TemplateVersionDefinition
// Errors associated with the template version.
Errors []types.TemplateError
// The descriptive name of the template.
Name *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// Status associated with the template.
// - 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 ID of the template described.
TemplateId *string
// The ARN of the theme of the template.
ThemeArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeTemplateDefinitionMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpDescribeTemplateDefinition{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDescribeTemplateDefinition{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeTemplateDefinition"); 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 = addOpDescribeTemplateDefinitionValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeTemplateDefinition(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_opDescribeTemplateDefinition(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DescribeTemplateDefinition",
}
}
|
