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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DescribeQueryOutput {
/// <p>The ID of the query.</p>
pub query_id: ::std::option::Option<::std::string::String>,
/// <p>The SQL code of a query.</p>
pub query_string: ::std::option::Option<::std::string::String>,
/// <p>The status of a query. Values for <code>QueryStatus</code> include <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>CANCELLED</code></p>
pub query_status: ::std::option::Option<crate::types::QueryStatus>,
/// <p>Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.</p>
pub query_statistics: ::std::option::Option<crate::types::QueryStatisticsForDescribeQuery>,
/// <p>The error message returned if a query failed.</p>
pub error_message: ::std::option::Option<::std::string::String>,
/// <p>The URI for the S3 bucket where CloudTrail delivered query results, if applicable.</p>
pub delivery_s3_uri: ::std::option::Option<::std::string::String>,
/// <p>The delivery status.</p>
pub delivery_status: ::std::option::Option<crate::types::DeliveryStatus>,
/// <p>The prompt used for a generated query. For information about generated queries, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-query-generator.html">Create CloudTrail Lake queries from natural language prompts</a> in the <i>CloudTrail </i> user guide.</p>
pub prompt: ::std::option::Option<::std::string::String>,
/// <p>The account ID of the event data store owner.</p>
pub event_data_store_owner_account_id: ::std::option::Option<::std::string::String>,
_request_id: Option<String>,
}
impl DescribeQueryOutput {
/// <p>The ID of the query.</p>
pub fn query_id(&self) -> ::std::option::Option<&str> {
self.query_id.as_deref()
}
/// <p>The SQL code of a query.</p>
pub fn query_string(&self) -> ::std::option::Option<&str> {
self.query_string.as_deref()
}
/// <p>The status of a query. Values for <code>QueryStatus</code> include <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>CANCELLED</code></p>
pub fn query_status(&self) -> ::std::option::Option<&crate::types::QueryStatus> {
self.query_status.as_ref()
}
/// <p>Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.</p>
pub fn query_statistics(&self) -> ::std::option::Option<&crate::types::QueryStatisticsForDescribeQuery> {
self.query_statistics.as_ref()
}
/// <p>The error message returned if a query failed.</p>
pub fn error_message(&self) -> ::std::option::Option<&str> {
self.error_message.as_deref()
}
/// <p>The URI for the S3 bucket where CloudTrail delivered query results, if applicable.</p>
pub fn delivery_s3_uri(&self) -> ::std::option::Option<&str> {
self.delivery_s3_uri.as_deref()
}
/// <p>The delivery status.</p>
pub fn delivery_status(&self) -> ::std::option::Option<&crate::types::DeliveryStatus> {
self.delivery_status.as_ref()
}
/// <p>The prompt used for a generated query. For information about generated queries, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-query-generator.html">Create CloudTrail Lake queries from natural language prompts</a> in the <i>CloudTrail </i> user guide.</p>
pub fn prompt(&self) -> ::std::option::Option<&str> {
self.prompt.as_deref()
}
/// <p>The account ID of the event data store owner.</p>
pub fn event_data_store_owner_account_id(&self) -> ::std::option::Option<&str> {
self.event_data_store_owner_account_id.as_deref()
}
}
impl ::aws_types::request_id::RequestId for DescribeQueryOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl DescribeQueryOutput {
/// Creates a new builder-style object to manufacture [`DescribeQueryOutput`](crate::operation::describe_query::DescribeQueryOutput).
pub fn builder() -> crate::operation::describe_query::builders::DescribeQueryOutputBuilder {
crate::operation::describe_query::builders::DescribeQueryOutputBuilder::default()
}
}
/// A builder for [`DescribeQueryOutput`](crate::operation::describe_query::DescribeQueryOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeQueryOutputBuilder {
pub(crate) query_id: ::std::option::Option<::std::string::String>,
pub(crate) query_string: ::std::option::Option<::std::string::String>,
pub(crate) query_status: ::std::option::Option<crate::types::QueryStatus>,
pub(crate) query_statistics: ::std::option::Option<crate::types::QueryStatisticsForDescribeQuery>,
pub(crate) error_message: ::std::option::Option<::std::string::String>,
pub(crate) delivery_s3_uri: ::std::option::Option<::std::string::String>,
pub(crate) delivery_status: ::std::option::Option<crate::types::DeliveryStatus>,
pub(crate) prompt: ::std::option::Option<::std::string::String>,
pub(crate) event_data_store_owner_account_id: ::std::option::Option<::std::string::String>,
_request_id: Option<String>,
}
impl DescribeQueryOutputBuilder {
/// <p>The ID of the query.</p>
pub fn query_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.query_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ID of the query.</p>
pub fn set_query_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.query_id = input;
self
}
/// <p>The ID of the query.</p>
pub fn get_query_id(&self) -> &::std::option::Option<::std::string::String> {
&self.query_id
}
/// <p>The SQL code of a query.</p>
pub fn query_string(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.query_string = ::std::option::Option::Some(input.into());
self
}
/// <p>The SQL code of a query.</p>
pub fn set_query_string(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.query_string = input;
self
}
/// <p>The SQL code of a query.</p>
pub fn get_query_string(&self) -> &::std::option::Option<::std::string::String> {
&self.query_string
}
/// <p>The status of a query. Values for <code>QueryStatus</code> include <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>CANCELLED</code></p>
pub fn query_status(mut self, input: crate::types::QueryStatus) -> Self {
self.query_status = ::std::option::Option::Some(input);
self
}
/// <p>The status of a query. Values for <code>QueryStatus</code> include <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>CANCELLED</code></p>
pub fn set_query_status(mut self, input: ::std::option::Option<crate::types::QueryStatus>) -> Self {
self.query_status = input;
self
}
/// <p>The status of a query. Values for <code>QueryStatus</code> include <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>CANCELLED</code></p>
pub fn get_query_status(&self) -> &::std::option::Option<crate::types::QueryStatus> {
&self.query_status
}
/// <p>Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.</p>
pub fn query_statistics(mut self, input: crate::types::QueryStatisticsForDescribeQuery) -> Self {
self.query_statistics = ::std::option::Option::Some(input);
self
}
/// <p>Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.</p>
pub fn set_query_statistics(mut self, input: ::std::option::Option<crate::types::QueryStatisticsForDescribeQuery>) -> Self {
self.query_statistics = input;
self
}
/// <p>Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.</p>
pub fn get_query_statistics(&self) -> &::std::option::Option<crate::types::QueryStatisticsForDescribeQuery> {
&self.query_statistics
}
/// <p>The error message returned if a query failed.</p>
pub fn error_message(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.error_message = ::std::option::Option::Some(input.into());
self
}
/// <p>The error message returned if a query failed.</p>
pub fn set_error_message(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.error_message = input;
self
}
/// <p>The error message returned if a query failed.</p>
pub fn get_error_message(&self) -> &::std::option::Option<::std::string::String> {
&self.error_message
}
/// <p>The URI for the S3 bucket where CloudTrail delivered query results, if applicable.</p>
pub fn delivery_s3_uri(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.delivery_s3_uri = ::std::option::Option::Some(input.into());
self
}
/// <p>The URI for the S3 bucket where CloudTrail delivered query results, if applicable.</p>
pub fn set_delivery_s3_uri(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.delivery_s3_uri = input;
self
}
/// <p>The URI for the S3 bucket where CloudTrail delivered query results, if applicable.</p>
pub fn get_delivery_s3_uri(&self) -> &::std::option::Option<::std::string::String> {
&self.delivery_s3_uri
}
/// <p>The delivery status.</p>
pub fn delivery_status(mut self, input: crate::types::DeliveryStatus) -> Self {
self.delivery_status = ::std::option::Option::Some(input);
self
}
/// <p>The delivery status.</p>
pub fn set_delivery_status(mut self, input: ::std::option::Option<crate::types::DeliveryStatus>) -> Self {
self.delivery_status = input;
self
}
/// <p>The delivery status.</p>
pub fn get_delivery_status(&self) -> &::std::option::Option<crate::types::DeliveryStatus> {
&self.delivery_status
}
/// <p>The prompt used for a generated query. For information about generated queries, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-query-generator.html">Create CloudTrail Lake queries from natural language prompts</a> in the <i>CloudTrail </i> user guide.</p>
pub fn prompt(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.prompt = ::std::option::Option::Some(input.into());
self
}
/// <p>The prompt used for a generated query. For information about generated queries, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-query-generator.html">Create CloudTrail Lake queries from natural language prompts</a> in the <i>CloudTrail </i> user guide.</p>
pub fn set_prompt(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.prompt = input;
self
}
/// <p>The prompt used for a generated query. For information about generated queries, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-query-generator.html">Create CloudTrail Lake queries from natural language prompts</a> in the <i>CloudTrail </i> user guide.</p>
pub fn get_prompt(&self) -> &::std::option::Option<::std::string::String> {
&self.prompt
}
/// <p>The account ID of the event data store owner.</p>
pub fn event_data_store_owner_account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.event_data_store_owner_account_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The account ID of the event data store owner.</p>
pub fn set_event_data_store_owner_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.event_data_store_owner_account_id = input;
self
}
/// <p>The account ID of the event data store owner.</p>
pub fn get_event_data_store_owner_account_id(&self) -> &::std::option::Option<::std::string::String> {
&self.event_data_store_owner_account_id
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`DescribeQueryOutput`](crate::operation::describe_query::DescribeQueryOutput).
pub fn build(self) -> crate::operation::describe_query::DescribeQueryOutput {
crate::operation::describe_query::DescribeQueryOutput {
query_id: self.query_id,
query_string: self.query_string,
query_status: self.query_status,
query_statistics: self.query_statistics,
error_message: self.error_message,
delivery_s3_uri: self.delivery_s3_uri,
delivery_status: self.delivery_status,
prompt: self.prompt,
event_data_store_owner_account_id: self.event_data_store_owner_account_id,
_request_id: self._request_id,
}
}
}