-
Notifications
You must be signed in to change notification settings - Fork 602
/
api_op_GetQueryResults.go
204 lines (173 loc) · 6.08 KB
/
api_op_GetQueryResults.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
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package athena
import (
"context"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
)
type GetQueryResultsInput struct {
_ struct{} `type:"structure"`
// The maximum number of results (rows) to return in this request.
MaxResults *int64 `min:"1" type:"integer"`
// The token that specifies where to start pagination if a previous request
// was truncated.
NextToken *string `min:"1" type:"string"`
// The unique ID of the query execution.
//
// QueryExecutionId is a required field
QueryExecutionId *string `type:"string" required:"true"`
}
// String returns the string representation
func (s GetQueryResultsInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *GetQueryResultsInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "GetQueryResultsInput"}
if s.MaxResults != nil && *s.MaxResults < 1 {
invalidParams.Add(aws.NewErrParamMinValue("MaxResults", 1))
}
if s.NextToken != nil && len(*s.NextToken) < 1 {
invalidParams.Add(aws.NewErrParamMinLen("NextToken", 1))
}
if s.QueryExecutionId == nil {
invalidParams.Add(aws.NewErrParamRequired("QueryExecutionId"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
type GetQueryResultsOutput struct {
_ struct{} `type:"structure"`
// A token to be used by the next request if this request is truncated.
NextToken *string `min:"1" type:"string"`
// The results of the query execution.
ResultSet *ResultSet `type:"structure"`
// The number of rows inserted with a CREATE TABLE AS SELECT statement.
UpdateCount *int64 `type:"long"`
}
// String returns the string representation
func (s GetQueryResultsOutput) String() string {
return awsutil.Prettify(s)
}
const opGetQueryResults = "GetQueryResults"
// GetQueryResultsRequest returns a request value for making API operation for
// Amazon Athena.
//
// Streams the results of a single query execution specified by QueryExecutionId
// from the Athena query results location in Amazon S3. For more information,
// see Query Results (https://docs.aws.amazon.com/athena/latest/ug/querying.html)
// in the Amazon Athena User Guide. This request does not execute the query
// but returns results. Use StartQueryExecution to run a query.
//
// To stream query results successfully, the IAM principal with permission to
// call GetQueryResults also must have permissions to the Amazon S3 GetObject
// action for the Athena query results location.
//
// IAM principals with permission to the Amazon S3 GetObject action for the
// query results location are able to retrieve query results from Amazon S3
// even if permission to the GetQueryResults action is denied. To restrict user
// or role access, ensure that Amazon S3 permissions to the Athena query location
// are denied.
//
// // Example sending a request using GetQueryResultsRequest.
// req := client.GetQueryResultsRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/GetQueryResults
func (c *Client) GetQueryResultsRequest(input *GetQueryResultsInput) GetQueryResultsRequest {
op := &aws.Operation{
Name: opGetQueryResults,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &aws.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &GetQueryResultsInput{}
}
req := c.newRequest(op, input, &GetQueryResultsOutput{})
return GetQueryResultsRequest{Request: req, Input: input, Copy: c.GetQueryResultsRequest}
}
// GetQueryResultsRequest is the request type for the
// GetQueryResults API operation.
type GetQueryResultsRequest struct {
*aws.Request
Input *GetQueryResultsInput
Copy func(*GetQueryResultsInput) GetQueryResultsRequest
}
// Send marshals and sends the GetQueryResults API request.
func (r GetQueryResultsRequest) Send(ctx context.Context) (*GetQueryResultsResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &GetQueryResultsResponse{
GetQueryResultsOutput: r.Request.Data.(*GetQueryResultsOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// NewGetQueryResultsRequestPaginator returns a paginator for GetQueryResults.
// Use Next method to get the next page, and CurrentPage to get the current
// response page from the paginator. Next will return false, if there are
// no more pages, or an error was encountered.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over pages.
// req := client.GetQueryResultsRequest(input)
// p := athena.NewGetQueryResultsRequestPaginator(req)
//
// for p.Next(context.TODO()) {
// page := p.CurrentPage()
// }
//
// if err := p.Err(); err != nil {
// return err
// }
//
func NewGetQueryResultsPaginator(req GetQueryResultsRequest) GetQueryResultsPaginator {
return GetQueryResultsPaginator{
Pager: aws.Pager{
NewRequest: func(ctx context.Context) (*aws.Request, error) {
var inCpy *GetQueryResultsInput
if req.Input != nil {
tmp := *req.Input
inCpy = &tmp
}
newReq := req.Copy(inCpy)
newReq.SetContext(ctx)
return newReq.Request, nil
},
},
}
}
// GetQueryResultsPaginator is used to paginate the request. This can be done by
// calling Next and CurrentPage.
type GetQueryResultsPaginator struct {
aws.Pager
}
func (p *GetQueryResultsPaginator) CurrentPage() *GetQueryResultsOutput {
return p.Pager.CurrentPage().(*GetQueryResultsOutput)
}
// GetQueryResultsResponse is the response type for the
// GetQueryResults API operation.
type GetQueryResultsResponse struct {
*GetQueryResultsOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// GetQueryResults request.
func (r *GetQueryResultsResponse) SDKResponseMetdata() *aws.Response {
return r.response
}