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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package internetmonitor
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/internetmonitor/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Start a query to return data for a specific query type for the Amazon
// CloudWatch Internet Monitor query interface. Specify a time period for the data
// that you want returned by using StartTime and EndTime . You filter the query
// results to return by providing parameters that you specify with FilterParameters
// .
//
// For more information about using the query interface, including examples, see [Using the Amazon CloudWatch Internet Monitor query interface]
// in the Amazon CloudWatch Internet Monitor User Guide.
//
// [Using the Amazon CloudWatch Internet Monitor query interface]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html
func (c *Client) StartQuery(ctx context.Context, params *StartQueryInput, optFns ...func(*Options)) (*StartQueryOutput, error) {
if params == nil {
params = &StartQueryInput{}
}
result, metadata, err := c.invokeOperation(ctx, "StartQuery", params, optFns, c.addOperationStartQueryMiddlewares)
if err != nil {
return nil, err
}
out := result.(*StartQueryOutput)
out.ResultMetadata = metadata
return out, nil
}
type StartQueryInput struct {
// The timestamp that is the end of the period that you want to retrieve data for
// with your query.
//
// This member is required.
EndTime *time.Time
// The name of the monitor to query.
//
// This member is required.
MonitorName *string
// The type of query to run. The following are the three types of queries that you
// can run using the Internet Monitor query interface:
//
// - MEASUREMENTS : Provides availability score, performance score, total
// traffic, and round-trip times, at 5 minute intervals.
//
// - TOP_LOCATIONS : Provides availability score, performance score, total
// traffic, and time to first byte (TTFB) information, for the top location and ASN
// combinations that you're monitoring, by traffic volume.
//
// - TOP_LOCATION_DETAILS : Provides TTFB for Amazon CloudFront, your current
// configuration, and the best performing EC2 configuration, at 1 hour intervals.
//
// For lists of the fields returned with each query type and more information
// about how each type of query is performed, see [Using the Amazon CloudWatch Internet Monitor query interface]in the Amazon CloudWatch
// Internet Monitor User Guide.
//
// [Using the Amazon CloudWatch Internet Monitor query interface]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html
//
// This member is required.
QueryType types.QueryType
// The timestamp that is the beginning of the period that you want to retrieve
// data for with your query.
//
// This member is required.
StartTime *time.Time
// The FilterParameters field that you use with Amazon CloudWatch Internet Monitor
// queries is a string the defines how you want a query to be filtered. The filter
// parameters that you can specify depend on the query type, since each query type
// returns a different set of Internet Monitor data.
//
// For more information about specifying filter parameters, see [Using the Amazon CloudWatch Internet Monitor query interface] in the Amazon
// CloudWatch Internet Monitor User Guide.
//
// [Using the Amazon CloudWatch Internet Monitor query interface]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-IM-view-cw-tools-cwim-query.html
FilterParameters []types.FilterParameter
// The account ID for an account that you've set up cross-account sharing for in
// Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using
// Amazon CloudWatch Observability Access Manager. For more information, see [Internet Monitor cross-account observability]in
// the Amazon CloudWatch Internet Monitor User Guide.
//
// [Internet Monitor cross-account observability]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cwim-cross-account.html
LinkedAccountId *string
noSmithyDocumentSerde
}
type StartQueryOutput struct {
// The internally-generated identifier of a specific query.
//
// This member is required.
QueryId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationStartQueryMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpStartQuery{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpStartQuery{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "StartQuery"); 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 = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpStartQueryValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opStartQuery(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_opStartQuery(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "StartQuery",
}
}
|
