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 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 DescribeSessionsInput {
/// <p>The name of the stack. This value is case-sensitive.</p>
pub stack_name: ::std::option::Option<::std::string::String>,
/// <p>The name of the fleet. This value is case-sensitive.</p>
pub fleet_name: ::std::option::Option<::std::string::String>,
/// <p>The user identifier (ID). If you specify a user ID, you must also specify the authentication type.</p>
pub user_id: ::std::option::Option<::std::string::String>,
/// <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
pub next_token: ::std::option::Option<::std::string::String>,
/// <p>The size of each page of results. The default value is 20 and the maximum value is 50.</p>
pub limit: ::std::option::Option<i32>,
/// <p>The authentication method. Specify <code>API</code> for a user authenticated using a streaming URL or <code>SAML</code> for a SAML federated user. The default is to authenticate users using a streaming URL.</p>
pub authentication_type: ::std::option::Option<crate::types::AuthenticationType>,
/// <p>The identifier for the instance hosting the session.</p>
pub instance_id: ::std::option::Option<::std::string::String>,
}
impl DescribeSessionsInput {
/// <p>The name of the stack. This value is case-sensitive.</p>
pub fn stack_name(&self) -> ::std::option::Option<&str> {
self.stack_name.as_deref()
}
/// <p>The name of the fleet. This value is case-sensitive.</p>
pub fn fleet_name(&self) -> ::std::option::Option<&str> {
self.fleet_name.as_deref()
}
/// <p>The user identifier (ID). If you specify a user ID, you must also specify the authentication type.</p>
pub fn user_id(&self) -> ::std::option::Option<&str> {
self.user_id.as_deref()
}
/// <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
pub fn next_token(&self) -> ::std::option::Option<&str> {
self.next_token.as_deref()
}
/// <p>The size of each page of results. The default value is 20 and the maximum value is 50.</p>
pub fn limit(&self) -> ::std::option::Option<i32> {
self.limit
}
/// <p>The authentication method. Specify <code>API</code> for a user authenticated using a streaming URL or <code>SAML</code> for a SAML federated user. The default is to authenticate users using a streaming URL.</p>
pub fn authentication_type(&self) -> ::std::option::Option<&crate::types::AuthenticationType> {
self.authentication_type.as_ref()
}
/// <p>The identifier for the instance hosting the session.</p>
pub fn instance_id(&self) -> ::std::option::Option<&str> {
self.instance_id.as_deref()
}
}
impl DescribeSessionsInput {
/// Creates a new builder-style object to manufacture [`DescribeSessionsInput`](crate::operation::describe_sessions::DescribeSessionsInput).
pub fn builder() -> crate::operation::describe_sessions::builders::DescribeSessionsInputBuilder {
crate::operation::describe_sessions::builders::DescribeSessionsInputBuilder::default()
}
}
/// A builder for [`DescribeSessionsInput`](crate::operation::describe_sessions::DescribeSessionsInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct DescribeSessionsInputBuilder {
pub(crate) stack_name: ::std::option::Option<::std::string::String>,
pub(crate) fleet_name: ::std::option::Option<::std::string::String>,
pub(crate) user_id: ::std::option::Option<::std::string::String>,
pub(crate) next_token: ::std::option::Option<::std::string::String>,
pub(crate) limit: ::std::option::Option<i32>,
pub(crate) authentication_type: ::std::option::Option<crate::types::AuthenticationType>,
pub(crate) instance_id: ::std::option::Option<::std::string::String>,
}
impl DescribeSessionsInputBuilder {
/// <p>The name of the stack. This value is case-sensitive.</p>
/// This field is required.
pub fn stack_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.stack_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the stack. This value is case-sensitive.</p>
pub fn set_stack_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.stack_name = input;
self
}
/// <p>The name of the stack. This value is case-sensitive.</p>
pub fn get_stack_name(&self) -> &::std::option::Option<::std::string::String> {
&self.stack_name
}
/// <p>The name of the fleet. This value is case-sensitive.</p>
/// This field is required.
pub fn fleet_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.fleet_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the fleet. This value is case-sensitive.</p>
pub fn set_fleet_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.fleet_name = input;
self
}
/// <p>The name of the fleet. This value is case-sensitive.</p>
pub fn get_fleet_name(&self) -> &::std::option::Option<::std::string::String> {
&self.fleet_name
}
/// <p>The user identifier (ID). If you specify a user ID, you must also specify the authentication type.</p>
pub fn user_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.user_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The user identifier (ID). If you specify a user ID, you must also specify the authentication type.</p>
pub fn set_user_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.user_id = input;
self
}
/// <p>The user identifier (ID). If you specify a user ID, you must also specify the authentication type.</p>
pub fn get_user_id(&self) -> &::std::option::Option<::std::string::String> {
&self.user_id
}
/// <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</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>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.next_token = input;
self
}
/// <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
&self.next_token
}
/// <p>The size of each page of results. The default value is 20 and the maximum value is 50.</p>
pub fn limit(mut self, input: i32) -> Self {
self.limit = ::std::option::Option::Some(input);
self
}
/// <p>The size of each page of results. The default value is 20 and the maximum value is 50.</p>
pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
self.limit = input;
self
}
/// <p>The size of each page of results. The default value is 20 and the maximum value is 50.</p>
pub fn get_limit(&self) -> &::std::option::Option<i32> {
&self.limit
}
/// <p>The authentication method. Specify <code>API</code> for a user authenticated using a streaming URL or <code>SAML</code> for a SAML federated user. The default is to authenticate users using a streaming URL.</p>
pub fn authentication_type(mut self, input: crate::types::AuthenticationType) -> Self {
self.authentication_type = ::std::option::Option::Some(input);
self
}
/// <p>The authentication method. Specify <code>API</code> for a user authenticated using a streaming URL or <code>SAML</code> for a SAML federated user. The default is to authenticate users using a streaming URL.</p>
pub fn set_authentication_type(mut self, input: ::std::option::Option<crate::types::AuthenticationType>) -> Self {
self.authentication_type = input;
self
}
/// <p>The authentication method. Specify <code>API</code> for a user authenticated using a streaming URL or <code>SAML</code> for a SAML federated user. The default is to authenticate users using a streaming URL.</p>
pub fn get_authentication_type(&self) -> &::std::option::Option<crate::types::AuthenticationType> {
&self.authentication_type
}
/// <p>The identifier for the instance hosting the session.</p>
pub fn instance_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.instance_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The identifier for the instance hosting the session.</p>
pub fn set_instance_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.instance_id = input;
self
}
/// <p>The identifier for the instance hosting the session.</p>
pub fn get_instance_id(&self) -> &::std::option::Option<::std::string::String> {
&self.instance_id
}
/// Consumes the builder and constructs a [`DescribeSessionsInput`](crate::operation::describe_sessions::DescribeSessionsInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::describe_sessions::DescribeSessionsInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::describe_sessions::DescribeSessionsInput {
stack_name: self.stack_name,
fleet_name: self.fleet_name,
user_id: self.user_id,
next_token: self.next_token,
limit: self.limit,
authentication_type: self.authentication_type,
instance_id: self.instance_id,
})
}
}