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
243
244
245
// 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 ListSessionsInput {
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.</p>
pub next_token: ::std::option::Option<::std::string::String>,
/// <p>The maximum number of sessions to return in the response. If more sessions exist than fit in one response, the operation returns <code>NextToken</code> to paginate the results.</p>
pub max_results: ::std::option::Option<i32>,
/// <p>The identifier of a specific session to return metadata for. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. When you provide <code>SessionId</code>, you can't specify <code>Status</code>, <code>ClusterIdentifier</code>, <code>WorkgroupName</code>, or <code>Database</code>.</p>
pub session_id: ::std::option::Option<::std::string::String>,
/// <p>The status of the sessions to list. If no status is specified, sessions with a status of <code>AVAILABLE</code> or <code>BUSY</code> are returned. Status values are defined as follows:</p>
/// <ul>
/// <li>
/// <p>AVAILABLE – The session is open and ready to run a SQL statement.</p></li>
/// <li>
/// <p>BUSY – The session is currently running a SQL statement.</p></li>
/// <li>
/// <p>CLOSED – The session is closed and can no longer run SQL statements.</p></li>
/// </ul>
pub status: ::std::option::Option<crate::types::SessionStatusString>,
/// <p>Specifies whether to return all sessions created by the caller's IAM role, including sessions from previous IAM sessions. If false, only sessions created in the current IAM session are returned. The default is true.</p>
pub role_level: ::std::option::Option<bool>,
/// <p>The cluster identifier. Only sessions on this cluster are returned. When providing <code>ClusterIdentifier</code>, then <code>WorkgroupName</code> can't be specified.</p>
pub cluster_identifier: ::std::option::Option<::std::string::String>,
/// <p>The serverless workgroup name or Amazon Resource Name (ARN). Only sessions on this workgroup are returned. When providing <code>WorkgroupName</code>, then <code>ClusterIdentifier</code> can't be specified.</p>
pub workgroup_name: ::std::option::Option<::std::string::String>,
/// <p>The name of the database. Only sessions connected to this database are returned.</p>
pub database: ::std::option::Option<::std::string::String>,
}
impl ListSessionsInput {
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.</p>
pub fn next_token(&self) -> ::std::option::Option<&str> {
self.next_token.as_deref()
}
/// <p>The maximum number of sessions to return in the response. If more sessions exist than fit in one response, the operation returns <code>NextToken</code> to paginate the results.</p>
pub fn max_results(&self) -> ::std::option::Option<i32> {
self.max_results
}
/// <p>The identifier of a specific session to return metadata for. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. When you provide <code>SessionId</code>, you can't specify <code>Status</code>, <code>ClusterIdentifier</code>, <code>WorkgroupName</code>, or <code>Database</code>.</p>
pub fn session_id(&self) -> ::std::option::Option<&str> {
self.session_id.as_deref()
}
/// <p>The status of the sessions to list. If no status is specified, sessions with a status of <code>AVAILABLE</code> or <code>BUSY</code> are returned. Status values are defined as follows:</p>
/// <ul>
/// <li>
/// <p>AVAILABLE – The session is open and ready to run a SQL statement.</p></li>
/// <li>
/// <p>BUSY – The session is currently running a SQL statement.</p></li>
/// <li>
/// <p>CLOSED – The session is closed and can no longer run SQL statements.</p></li>
/// </ul>
pub fn status(&self) -> ::std::option::Option<&crate::types::SessionStatusString> {
self.status.as_ref()
}
/// <p>Specifies whether to return all sessions created by the caller's IAM role, including sessions from previous IAM sessions. If false, only sessions created in the current IAM session are returned. The default is true.</p>
pub fn role_level(&self) -> ::std::option::Option<bool> {
self.role_level
}
/// <p>The cluster identifier. Only sessions on this cluster are returned. When providing <code>ClusterIdentifier</code>, then <code>WorkgroupName</code> can't be specified.</p>
pub fn cluster_identifier(&self) -> ::std::option::Option<&str> {
self.cluster_identifier.as_deref()
}
/// <p>The serverless workgroup name or Amazon Resource Name (ARN). Only sessions on this workgroup are returned. When providing <code>WorkgroupName</code>, then <code>ClusterIdentifier</code> can't be specified.</p>
pub fn workgroup_name(&self) -> ::std::option::Option<&str> {
self.workgroup_name.as_deref()
}
/// <p>The name of the database. Only sessions connected to this database are returned.</p>
pub fn database(&self) -> ::std::option::Option<&str> {
self.database.as_deref()
}
}
impl ListSessionsInput {
/// Creates a new builder-style object to manufacture [`ListSessionsInput`](crate::operation::list_sessions::ListSessionsInput).
pub fn builder() -> crate::operation::list_sessions::builders::ListSessionsInputBuilder {
crate::operation::list_sessions::builders::ListSessionsInputBuilder::default()
}
}
/// A builder for [`ListSessionsInput`](crate::operation::list_sessions::ListSessionsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ListSessionsInputBuilder {
pub(crate) next_token: ::std::option::Option<::std::string::String>,
pub(crate) max_results: ::std::option::Option<i32>,
pub(crate) session_id: ::std::option::Option<::std::string::String>,
pub(crate) status: ::std::option::Option<crate::types::SessionStatusString>,
pub(crate) role_level: ::std::option::Option<bool>,
pub(crate) cluster_identifier: ::std::option::Option<::std::string::String>,
pub(crate) workgroup_name: ::std::option::Option<::std::string::String>,
pub(crate) database: ::std::option::Option<::std::string::String>,
}
impl ListSessionsInputBuilder {
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.</p>
pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.next_token = ::std::option::Option::Some(input.into());
self
}
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.</p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.next_token = input;
self
}
/// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
&self.next_token
}
/// <p>The maximum number of sessions to return in the response. If more sessions exist than fit in one response, the operation returns <code>NextToken</code> to paginate the results.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.max_results = ::std::option::Option::Some(input);
self
}
/// <p>The maximum number of sessions to return in the response. If more sessions exist than fit in one response, the operation returns <code>NextToken</code> to paginate the results.</p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_results = input;
self
}
/// <p>The maximum number of sessions to return in the response. If more sessions exist than fit in one response, the operation returns <code>NextToken</code> to paginate the results.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
&self.max_results
}
/// <p>The identifier of a specific session to return metadata for. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. When you provide <code>SessionId</code>, you can't specify <code>Status</code>, <code>ClusterIdentifier</code>, <code>WorkgroupName</code>, or <code>Database</code>.</p>
pub fn session_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.session_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The identifier of a specific session to return metadata for. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. When you provide <code>SessionId</code>, you can't specify <code>Status</code>, <code>ClusterIdentifier</code>, <code>WorkgroupName</code>, or <code>Database</code>.</p>
pub fn set_session_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.session_id = input;
self
}
/// <p>The identifier of a specific session to return metadata for. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. When you provide <code>SessionId</code>, you can't specify <code>Status</code>, <code>ClusterIdentifier</code>, <code>WorkgroupName</code>, or <code>Database</code>.</p>
pub fn get_session_id(&self) -> &::std::option::Option<::std::string::String> {
&self.session_id
}
/// <p>The status of the sessions to list. If no status is specified, sessions with a status of <code>AVAILABLE</code> or <code>BUSY</code> are returned. Status values are defined as follows:</p>
/// <ul>
/// <li>
/// <p>AVAILABLE – The session is open and ready to run a SQL statement.</p></li>
/// <li>
/// <p>BUSY – The session is currently running a SQL statement.</p></li>
/// <li>
/// <p>CLOSED – The session is closed and can no longer run SQL statements.</p></li>
/// </ul>
pub fn status(mut self, input: crate::types::SessionStatusString) -> Self {
self.status = ::std::option::Option::Some(input);
self
}
/// <p>The status of the sessions to list. If no status is specified, sessions with a status of <code>AVAILABLE</code> or <code>BUSY</code> are returned. Status values are defined as follows:</p>
/// <ul>
/// <li>
/// <p>AVAILABLE – The session is open and ready to run a SQL statement.</p></li>
/// <li>
/// <p>BUSY – The session is currently running a SQL statement.</p></li>
/// <li>
/// <p>CLOSED – The session is closed and can no longer run SQL statements.</p></li>
/// </ul>
pub fn set_status(mut self, input: ::std::option::Option<crate::types::SessionStatusString>) -> Self {
self.status = input;
self
}
/// <p>The status of the sessions to list. If no status is specified, sessions with a status of <code>AVAILABLE</code> or <code>BUSY</code> are returned. Status values are defined as follows:</p>
/// <ul>
/// <li>
/// <p>AVAILABLE – The session is open and ready to run a SQL statement.</p></li>
/// <li>
/// <p>BUSY – The session is currently running a SQL statement.</p></li>
/// <li>
/// <p>CLOSED – The session is closed and can no longer run SQL statements.</p></li>
/// </ul>
pub fn get_status(&self) -> &::std::option::Option<crate::types::SessionStatusString> {
&self.status
}
/// <p>Specifies whether to return all sessions created by the caller's IAM role, including sessions from previous IAM sessions. If false, only sessions created in the current IAM session are returned. The default is true.</p>
pub fn role_level(mut self, input: bool) -> Self {
self.role_level = ::std::option::Option::Some(input);
self
}
/// <p>Specifies whether to return all sessions created by the caller's IAM role, including sessions from previous IAM sessions. If false, only sessions created in the current IAM session are returned. The default is true.</p>
pub fn set_role_level(mut self, input: ::std::option::Option<bool>) -> Self {
self.role_level = input;
self
}
/// <p>Specifies whether to return all sessions created by the caller's IAM role, including sessions from previous IAM sessions. If false, only sessions created in the current IAM session are returned. The default is true.</p>
pub fn get_role_level(&self) -> &::std::option::Option<bool> {
&self.role_level
}
/// <p>The cluster identifier. Only sessions on this cluster are returned. When providing <code>ClusterIdentifier</code>, then <code>WorkgroupName</code> can't be specified.</p>
pub fn cluster_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.cluster_identifier = ::std::option::Option::Some(input.into());
self
}
/// <p>The cluster identifier. Only sessions on this cluster are returned. When providing <code>ClusterIdentifier</code>, then <code>WorkgroupName</code> can't be specified.</p>
pub fn set_cluster_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.cluster_identifier = input;
self
}
/// <p>The cluster identifier. Only sessions on this cluster are returned. When providing <code>ClusterIdentifier</code>, then <code>WorkgroupName</code> can't be specified.</p>
pub fn get_cluster_identifier(&self) -> &::std::option::Option<::std::string::String> {
&self.cluster_identifier
}
/// <p>The serverless workgroup name or Amazon Resource Name (ARN). Only sessions on this workgroup are returned. When providing <code>WorkgroupName</code>, then <code>ClusterIdentifier</code> can't be specified.</p>
pub fn workgroup_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.workgroup_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The serverless workgroup name or Amazon Resource Name (ARN). Only sessions on this workgroup are returned. When providing <code>WorkgroupName</code>, then <code>ClusterIdentifier</code> can't be specified.</p>
pub fn set_workgroup_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.workgroup_name = input;
self
}
/// <p>The serverless workgroup name or Amazon Resource Name (ARN). Only sessions on this workgroup are returned. When providing <code>WorkgroupName</code>, then <code>ClusterIdentifier</code> can't be specified.</p>
pub fn get_workgroup_name(&self) -> &::std::option::Option<::std::string::String> {
&self.workgroup_name
}
/// <p>The name of the database. Only sessions connected to this database are returned.</p>
pub fn database(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.database = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the database. Only sessions connected to this database are returned.</p>
pub fn set_database(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.database = input;
self
}
/// <p>The name of the database. Only sessions connected to this database are returned.</p>
pub fn get_database(&self) -> &::std::option::Option<::std::string::String> {
&self.database
}
/// Consumes the builder and constructs a [`ListSessionsInput`](crate::operation::list_sessions::ListSessionsInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::list_sessions::ListSessionsInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::list_sessions::ListSessionsInput {
next_token: self.next_token,
max_results: self.max_results,
session_id: self.session_id,
status: self.status,
role_level: self.role_level,
cluster_identifier: self.cluster_identifier,
workgroup_name: self.workgroup_name,
database: self.database,
})
}
}