aws-sdk-ssm 1.131.0

AWS SDK for Amazon Simple Systems Manager (SSM)
Documentation
// 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 session status to retrieve a list of sessions for. For example, "Active".</p>
    pub state: ::std::option::Option<crate::types::SessionState>,
    /// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
    pub max_results: ::std::option::Option<i32>,
    /// <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
    pub next_token: ::std::option::Option<::std::string::String>,
    /// <p>One or more filters to limit the type of sessions returned by the request.</p>
    pub filters: ::std::option::Option<::std::vec::Vec<crate::types::SessionFilter>>,
}
impl DescribeSessionsInput {
    /// <p>The session status to retrieve a list of sessions for. For example, "Active".</p>
    pub fn state(&self) -> ::std::option::Option<&crate::types::SessionState> {
        self.state.as_ref()
    }
    /// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
    pub fn max_results(&self) -> ::std::option::Option<i32> {
        self.max_results
    }
    /// <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
    /// <p>One or more filters to limit the type of sessions returned by the request.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.filters.is_none()`.
    pub fn filters(&self) -> &[crate::types::SessionFilter] {
        self.filters.as_deref().unwrap_or_default()
    }
}
static DESCRIBESESSIONSINPUT_MEMBER_STATE: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#DescribeSessionsInput$State",
        "com.amazonaws.ssm.synthetic",
        "DescribeSessionsInput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "State",
    0,
);
static DESCRIBESESSIONSINPUT_MEMBER_MAX_RESULTS: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#DescribeSessionsInput$MaxResults",
        "com.amazonaws.ssm.synthetic",
        "DescribeSessionsInput",
    ),
    ::aws_smithy_schema::ShapeType::Integer,
    "MaxResults",
    1,
);
static DESCRIBESESSIONSINPUT_MEMBER_NEXT_TOKEN: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#DescribeSessionsInput$NextToken",
        "com.amazonaws.ssm.synthetic",
        "DescribeSessionsInput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "NextToken",
    2,
);
static DESCRIBESESSIONSINPUT_MEMBER_FILTERS_MEMBER: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts("com.amazonaws.ssm#SessionFilterList$member", "com.amazonaws.ssm", "SessionFilterList"),
    ::aws_smithy_schema::ShapeType::Structure,
    "member",
    0,
);
static DESCRIBESESSIONSINPUT_MEMBER_FILTERS: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#DescribeSessionsInput$Filters",
        "com.amazonaws.ssm.synthetic",
        "DescribeSessionsInput",
    ),
    ::aws_smithy_schema::ShapeType::List,
    "Filters",
    3,
)
.with_list_member(&DESCRIBESESSIONSINPUT_MEMBER_FILTERS_MEMBER);
static DESCRIBESESSIONSINPUT_SCHEMA: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_struct(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#DescribeSessionsInput",
        "com.amazonaws.ssm.synthetic",
        "DescribeSessionsInput",
    ),
    ::aws_smithy_schema::ShapeType::Structure,
    &[
        &DESCRIBESESSIONSINPUT_MEMBER_STATE,
        &DESCRIBESESSIONSINPUT_MEMBER_MAX_RESULTS,
        &DESCRIBESESSIONSINPUT_MEMBER_NEXT_TOKEN,
        &DESCRIBESESSIONSINPUT_MEMBER_FILTERS,
    ],
)
.with_payload_hint(::aws_smithy_schema::PayloadHint::NoStructPayload)
.with_original_name("DescribeSessionsRequest");
impl DescribeSessionsInput {
    /// The schema for this shape.
    pub const SCHEMA: &'static ::aws_smithy_schema::Schema<'static> = &DESCRIBESESSIONSINPUT_SCHEMA;
}
impl ::aws_smithy_schema::serde::SerializableStruct for DescribeSessionsInput {
    fn schema(&self) -> &::aws_smithy_schema::Schema<'_> {
        Self::SCHEMA
    }

    #[allow(unused_variables, clippy::diverging_sub_expression)]
    fn serialize_members(
        &self,
        ser: &mut dyn ::aws_smithy_schema::serde::ShapeSerializer,
    ) -> ::std::result::Result<(), ::aws_smithy_schema::serde::SerdeError> {
        if let Some(ref val) = self.state {
            ser.write_string(&DESCRIBESESSIONSINPUT_MEMBER_STATE, val.as_str())?;
        }
        if let Some(ref val) = self.max_results {
            ser.write_integer(&DESCRIBESESSIONSINPUT_MEMBER_MAX_RESULTS, *val)?;
        }
        if let Some(ref val) = self.next_token {
            ser.write_string(&DESCRIBESESSIONSINPUT_MEMBER_NEXT_TOKEN, val)?;
        }
        if let Some(ref val) = self.filters {
            ser.write_list(
                &DESCRIBESESSIONSINPUT_MEMBER_FILTERS,
                &|ser: &mut dyn ::aws_smithy_schema::serde::ShapeSerializer| {
                    for item in val {
                        ser.write_struct(crate::types::SessionFilter::SCHEMA, item)?;
                    }
                    Ok(())
                },
            )?;
        }
        Ok(())
    }
}
impl crate::operation::describe_sessions::builders::DescribeSessionsInputBuilder {
    #[allow(
        unused_variables,
        unreachable_code,
        clippy::single_match,
        clippy::match_single_binding,
        clippy::diverging_sub_expression
    )]
    pub(crate) fn deserialize_members(
        &mut self,
        deserializer: &mut dyn ::aws_smithy_schema::serde::ShapeDeserializer,
    ) -> ::std::result::Result<(), ::aws_smithy_schema::serde::SerdeError> {
        deserializer.read_struct(&DESCRIBESESSIONSINPUT_SCHEMA, &mut |member, deser| {
            match member.member_index() {
                Some(0) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.state = Some(crate::types::SessionState::from(deser.read_string(member)?.as_str()));
                    }
                }
                Some(1) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.max_results = Some(deser.read_integer(member)?);
                    }
                }
                Some(2) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.next_token = Some(deser.read_string(member)?);
                    }
                }
                Some(3) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.filters = Some({
                            let mut container = Vec::new();
                            deser.read_list(member, &mut |deser| {
                                container.push(crate::types::SessionFilter::deserialize(deser)?);
                                Ok(())
                            })?;
                            container
                        });
                    }
                }
                _ => {}
            }
            Ok(())
        })
    }
}

impl DescribeSessionsInput {
    /// Deserializes this structure from a [`ShapeDeserializer`].
    pub fn deserialize(
        deserializer: &mut dyn ::aws_smithy_schema::serde::ShapeDeserializer,
    ) -> ::std::result::Result<Self, ::aws_smithy_schema::serde::SerdeError> {
        let mut builder = Self::builder();
        builder.deserialize_members(deserializer)?;
        builder.build().map_err(|e| aws_smithy_schema::serde::SerdeError::custom(e.to_string()))
    }
}
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).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeSessionsInputBuilder {
    pub(crate) state: ::std::option::Option<crate::types::SessionState>,
    pub(crate) max_results: ::std::option::Option<i32>,
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
    pub(crate) filters: ::std::option::Option<::std::vec::Vec<crate::types::SessionFilter>>,
}
impl DescribeSessionsInputBuilder {
    /// <p>The session status to retrieve a list of sessions for. For example, "Active".</p>
    /// This field is required.
    pub fn state(mut self, input: crate::types::SessionState) -> Self {
        self.state = ::std::option::Option::Some(input);
        self
    }
    /// <p>The session status to retrieve a list of sessions for. For example, "Active".</p>
    pub fn set_state(mut self, input: ::std::option::Option<crate::types::SessionState>) -> Self {
        self.state = input;
        self
    }
    /// <p>The session status to retrieve a list of sessions for. For example, "Active".</p>
    pub fn get_state(&self) -> &::std::option::Option<crate::types::SessionState> {
        &self.state
    }
    /// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of 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 items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of 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 items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        &self.max_results
    }
    /// <p>The token for the next set of items to return. (You received this token from a previous call.)</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 token for the next set of items to return. (You received this token from a previous call.)</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    /// Appends an item to `filters`.
    ///
    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
    ///
    /// <p>One or more filters to limit the type of sessions returned by the request.</p>
    pub fn filters(mut self, input: crate::types::SessionFilter) -> Self {
        let mut v = self.filters.unwrap_or_default();
        v.push(input);
        self.filters = ::std::option::Option::Some(v);
        self
    }
    /// <p>One or more filters to limit the type of sessions returned by the request.</p>
    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::SessionFilter>>) -> Self {
        self.filters = input;
        self
    }
    /// <p>One or more filters to limit the type of sessions returned by the request.</p>
    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::SessionFilter>> {
        &self.filters
    }
    /// 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 {
            state: self.state,
            max_results: self.max_results,
            next_token: self.next_token,
            filters: self.filters,
        })
    }
}