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 DescribeDocumentPermissionInput {
    /// <p>The name of the document for which you are the owner.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The permission type for the document. The permission type can be <i>Share</i>.</p>
    pub permission_type: ::std::option::Option<crate::types::DocumentPermissionType>,
    /// <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>,
}
impl DescribeDocumentPermissionInput {
    /// <p>The name of the document for which you are the owner.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The permission type for the document. The permission type can be <i>Share</i>.</p>
    pub fn permission_type(&self) -> ::std::option::Option<&crate::types::DocumentPermissionType> {
        self.permission_type.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()
    }
}
static DESCRIBEDOCUMENTPERMISSIONINPUT_MEMBER_NAME: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#DescribeDocumentPermissionInput$Name",
        "com.amazonaws.ssm.synthetic",
        "DescribeDocumentPermissionInput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "Name",
    0,
);
static DESCRIBEDOCUMENTPERMISSIONINPUT_MEMBER_PERMISSION_TYPE: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#DescribeDocumentPermissionInput$PermissionType",
        "com.amazonaws.ssm.synthetic",
        "DescribeDocumentPermissionInput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "PermissionType",
    1,
);
static DESCRIBEDOCUMENTPERMISSIONINPUT_MEMBER_MAX_RESULTS: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#DescribeDocumentPermissionInput$MaxResults",
        "com.amazonaws.ssm.synthetic",
        "DescribeDocumentPermissionInput",
    ),
    ::aws_smithy_schema::ShapeType::Integer,
    "MaxResults",
    2,
);
static DESCRIBEDOCUMENTPERMISSIONINPUT_MEMBER_NEXT_TOKEN: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#DescribeDocumentPermissionInput$NextToken",
        "com.amazonaws.ssm.synthetic",
        "DescribeDocumentPermissionInput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "NextToken",
    3,
);
static DESCRIBEDOCUMENTPERMISSIONINPUT_SCHEMA: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_struct(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#DescribeDocumentPermissionInput",
        "com.amazonaws.ssm.synthetic",
        "DescribeDocumentPermissionInput",
    ),
    ::aws_smithy_schema::ShapeType::Structure,
    &[
        &DESCRIBEDOCUMENTPERMISSIONINPUT_MEMBER_NAME,
        &DESCRIBEDOCUMENTPERMISSIONINPUT_MEMBER_PERMISSION_TYPE,
        &DESCRIBEDOCUMENTPERMISSIONINPUT_MEMBER_MAX_RESULTS,
        &DESCRIBEDOCUMENTPERMISSIONINPUT_MEMBER_NEXT_TOKEN,
    ],
)
.with_payload_hint(::aws_smithy_schema::PayloadHint::NoStructPayload)
.with_original_name("DescribeDocumentPermissionRequest");
impl DescribeDocumentPermissionInput {
    /// The schema for this shape.
    pub const SCHEMA: &'static ::aws_smithy_schema::Schema<'static> = &DESCRIBEDOCUMENTPERMISSIONINPUT_SCHEMA;
}
impl ::aws_smithy_schema::serde::SerializableStruct for DescribeDocumentPermissionInput {
    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.name {
            ser.write_string(&DESCRIBEDOCUMENTPERMISSIONINPUT_MEMBER_NAME, val)?;
        }
        if let Some(ref val) = self.permission_type {
            ser.write_string(&DESCRIBEDOCUMENTPERMISSIONINPUT_MEMBER_PERMISSION_TYPE, val.as_str())?;
        }
        if let Some(ref val) = self.max_results {
            ser.write_integer(&DESCRIBEDOCUMENTPERMISSIONINPUT_MEMBER_MAX_RESULTS, *val)?;
        }
        if let Some(ref val) = self.next_token {
            ser.write_string(&DESCRIBEDOCUMENTPERMISSIONINPUT_MEMBER_NEXT_TOKEN, val)?;
        }
        Ok(())
    }
}
impl crate::operation::describe_document_permission::builders::DescribeDocumentPermissionInputBuilder {
    #[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(&DESCRIBEDOCUMENTPERMISSIONINPUT_SCHEMA, &mut |member, deser| {
            match member.member_index() {
                Some(0) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.name = Some(deser.read_string(member)?);
                    }
                }
                Some(1) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.permission_type = Some(crate::types::DocumentPermissionType::from(deser.read_string(member)?.as_str()));
                    }
                }
                Some(2) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.max_results = Some(deser.read_integer(member)?);
                    }
                }
                Some(3) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.next_token = Some(deser.read_string(member)?);
                    }
                }
                _ => {}
            }
            Ok(())
        })
    }
}

impl DescribeDocumentPermissionInput {
    /// 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.name = builder.name.or(Some(String::new()));
        builder.build().map_err(|e| aws_smithy_schema::serde::SerdeError::custom(e.to_string()))
    }
}
impl DescribeDocumentPermissionInput {
    /// Creates a new builder-style object to manufacture [`DescribeDocumentPermissionInput`](crate::operation::describe_document_permission::DescribeDocumentPermissionInput).
    pub fn builder() -> crate::operation::describe_document_permission::builders::DescribeDocumentPermissionInputBuilder {
        crate::operation::describe_document_permission::builders::DescribeDocumentPermissionInputBuilder::default()
    }
}

/// A builder for [`DescribeDocumentPermissionInput`](crate::operation::describe_document_permission::DescribeDocumentPermissionInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeDocumentPermissionInputBuilder {
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) permission_type: ::std::option::Option<crate::types::DocumentPermissionType>,
    pub(crate) max_results: ::std::option::Option<i32>,
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
}
impl DescribeDocumentPermissionInputBuilder {
    /// <p>The name of the document for which you are the owner.</p>
    /// This field is required.
    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the document for which you are the owner.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the document for which you are the owner.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The permission type for the document. The permission type can be <i>Share</i>.</p>
    /// This field is required.
    pub fn permission_type(mut self, input: crate::types::DocumentPermissionType) -> Self {
        self.permission_type = ::std::option::Option::Some(input);
        self
    }
    /// <p>The permission type for the document. The permission type can be <i>Share</i>.</p>
    pub fn set_permission_type(mut self, input: ::std::option::Option<crate::types::DocumentPermissionType>) -> Self {
        self.permission_type = input;
        self
    }
    /// <p>The permission type for the document. The permission type can be <i>Share</i>.</p>
    pub fn get_permission_type(&self) -> &::std::option::Option<crate::types::DocumentPermissionType> {
        &self.permission_type
    }
    /// <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
    }
    /// Consumes the builder and constructs a [`DescribeDocumentPermissionInput`](crate::operation::describe_document_permission::DescribeDocumentPermissionInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<
        crate::operation::describe_document_permission::DescribeDocumentPermissionInput,
        ::aws_smithy_types::error::operation::BuildError,
    > {
        ::std::result::Result::Ok(crate::operation::describe_document_permission::DescribeDocumentPermissionInput {
            name: self.name,
            permission_type: self.permission_type,
            max_results: self.max_results,
            next_token: self.next_token,
        })
    }
}