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 ModifyDocumentPermissionInput {
    /// <p>The name of the document that you want to share.</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 Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or <i>All</i>. You must specify a value for this parameter or the <code>AccountIdsToRemove</code> parameter.</p>
    pub account_ids_to_add: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or <i>All</i>. This action has a higher priority than <code>AccountIdsToAdd</code>. If you specify an ID to add and the same ID to remove, the system removes access to the document. You must specify a value for this parameter or the <code>AccountIdsToAdd</code> parameter.</p>
    pub account_ids_to_remove: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>(Optional) The version of the document to share. If it isn't specified, the system choose the <code>Default</code> version to share.</p>
    pub shared_document_version: ::std::option::Option<::std::string::String>,
}
impl ModifyDocumentPermissionInput {
    /// <p>The name of the document that you want to share.</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 Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or <i>All</i>. You must specify a value for this parameter or the <code>AccountIdsToRemove</code> parameter.</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 `.account_ids_to_add.is_none()`.
    pub fn account_ids_to_add(&self) -> &[::std::string::String] {
        self.account_ids_to_add.as_deref().unwrap_or_default()
    }
    /// <p>The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or <i>All</i>. This action has a higher priority than <code>AccountIdsToAdd</code>. If you specify an ID to add and the same ID to remove, the system removes access to the document. You must specify a value for this parameter or the <code>AccountIdsToAdd</code> parameter.</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 `.account_ids_to_remove.is_none()`.
    pub fn account_ids_to_remove(&self) -> &[::std::string::String] {
        self.account_ids_to_remove.as_deref().unwrap_or_default()
    }
    /// <p>(Optional) The version of the document to share. If it isn't specified, the system choose the <code>Default</code> version to share.</p>
    pub fn shared_document_version(&self) -> ::std::option::Option<&str> {
        self.shared_document_version.as_deref()
    }
}
static MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_NAME: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#ModifyDocumentPermissionInput$Name",
        "com.amazonaws.ssm.synthetic",
        "ModifyDocumentPermissionInput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "Name",
    0,
);
static MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_PERMISSION_TYPE: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#ModifyDocumentPermissionInput$PermissionType",
        "com.amazonaws.ssm.synthetic",
        "ModifyDocumentPermissionInput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "PermissionType",
    1,
);
static MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_ACCOUNT_IDS_TO_ADD_MEMBER: ::aws_smithy_schema::Schema<'static> =
    ::aws_smithy_schema::Schema::new_member(
        ::aws_smithy_schema::ShapeId::from_parts("com.amazonaws.ssm#AccountIdList$member", "com.amazonaws.ssm", "AccountIdList"),
        ::aws_smithy_schema::ShapeType::String,
        "member",
        0,
    )
    .with_xml_name("AccountId");
static MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_ACCOUNT_IDS_TO_ADD: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#ModifyDocumentPermissionInput$AccountIdsToAdd",
        "com.amazonaws.ssm.synthetic",
        "ModifyDocumentPermissionInput",
    ),
    ::aws_smithy_schema::ShapeType::List,
    "AccountIdsToAdd",
    2,
)
.with_list_member(&MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_ACCOUNT_IDS_TO_ADD_MEMBER);
static MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_ACCOUNT_IDS_TO_REMOVE_MEMBER: ::aws_smithy_schema::Schema<'static> =
    ::aws_smithy_schema::Schema::new_member(
        ::aws_smithy_schema::ShapeId::from_parts("com.amazonaws.ssm#AccountIdList$member", "com.amazonaws.ssm", "AccountIdList"),
        ::aws_smithy_schema::ShapeType::String,
        "member",
        0,
    )
    .with_xml_name("AccountId");
static MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_ACCOUNT_IDS_TO_REMOVE: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#ModifyDocumentPermissionInput$AccountIdsToRemove",
        "com.amazonaws.ssm.synthetic",
        "ModifyDocumentPermissionInput",
    ),
    ::aws_smithy_schema::ShapeType::List,
    "AccountIdsToRemove",
    3,
)
.with_list_member(&MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_ACCOUNT_IDS_TO_REMOVE_MEMBER);
static MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_SHARED_DOCUMENT_VERSION: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#ModifyDocumentPermissionInput$SharedDocumentVersion",
        "com.amazonaws.ssm.synthetic",
        "ModifyDocumentPermissionInput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "SharedDocumentVersion",
    4,
);
static MODIFYDOCUMENTPERMISSIONINPUT_SCHEMA: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_struct(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#ModifyDocumentPermissionInput",
        "com.amazonaws.ssm.synthetic",
        "ModifyDocumentPermissionInput",
    ),
    ::aws_smithy_schema::ShapeType::Structure,
    &[
        &MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_NAME,
        &MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_PERMISSION_TYPE,
        &MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_ACCOUNT_IDS_TO_ADD,
        &MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_ACCOUNT_IDS_TO_REMOVE,
        &MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_SHARED_DOCUMENT_VERSION,
    ],
)
.with_payload_hint(::aws_smithy_schema::PayloadHint::NoStructPayload)
.with_original_name("ModifyDocumentPermissionRequest");
impl ModifyDocumentPermissionInput {
    /// The schema for this shape.
    pub const SCHEMA: &'static ::aws_smithy_schema::Schema<'static> = &MODIFYDOCUMENTPERMISSIONINPUT_SCHEMA;
}
impl ::aws_smithy_schema::serde::SerializableStruct for ModifyDocumentPermissionInput {
    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(&MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_NAME, val)?;
        }
        if let Some(ref val) = self.permission_type {
            ser.write_string(&MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_PERMISSION_TYPE, val.as_str())?;
        }
        if let Some(ref val) = self.account_ids_to_add {
            ser.write_list(
                &MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_ACCOUNT_IDS_TO_ADD,
                &|ser: &mut dyn ::aws_smithy_schema::serde::ShapeSerializer| {
                    for item in val {
                        ser.write_string(&aws_smithy_schema::prelude::STRING, item)?;
                    }
                    Ok(())
                },
            )?;
        }
        if let Some(ref val) = self.account_ids_to_remove {
            ser.write_list(
                &MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_ACCOUNT_IDS_TO_REMOVE,
                &|ser: &mut dyn ::aws_smithy_schema::serde::ShapeSerializer| {
                    for item in val {
                        ser.write_string(&aws_smithy_schema::prelude::STRING, item)?;
                    }
                    Ok(())
                },
            )?;
        }
        if let Some(ref val) = self.shared_document_version {
            ser.write_string(&MODIFYDOCUMENTPERMISSIONINPUT_MEMBER_SHARED_DOCUMENT_VERSION, val)?;
        }
        Ok(())
    }
}
impl crate::operation::modify_document_permission::builders::ModifyDocumentPermissionInputBuilder {
    #[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(&MODIFYDOCUMENTPERMISSIONINPUT_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.account_ids_to_add = Some(deser.read_string_list(member)?);
                    }
                }
                Some(3) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.account_ids_to_remove = Some(deser.read_string_list(member)?);
                    }
                }
                Some(4) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.shared_document_version = Some(deser.read_string(member)?);
                    }
                }
                _ => {}
            }
            Ok(())
        })
    }
}

impl ModifyDocumentPermissionInput {
    /// 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 ModifyDocumentPermissionInput {
    /// Creates a new builder-style object to manufacture [`ModifyDocumentPermissionInput`](crate::operation::modify_document_permission::ModifyDocumentPermissionInput).
    pub fn builder() -> crate::operation::modify_document_permission::builders::ModifyDocumentPermissionInputBuilder {
        crate::operation::modify_document_permission::builders::ModifyDocumentPermissionInputBuilder::default()
    }
}

/// A builder for [`ModifyDocumentPermissionInput`](crate::operation::modify_document_permission::ModifyDocumentPermissionInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ModifyDocumentPermissionInputBuilder {
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) permission_type: ::std::option::Option<crate::types::DocumentPermissionType>,
    pub(crate) account_ids_to_add: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) account_ids_to_remove: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) shared_document_version: ::std::option::Option<::std::string::String>,
}
impl ModifyDocumentPermissionInputBuilder {
    /// <p>The name of the document that you want to share.</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 that you want to share.</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 that you want to share.</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
    }
    /// Appends an item to `account_ids_to_add`.
    ///
    /// To override the contents of this collection use [`set_account_ids_to_add`](Self::set_account_ids_to_add).
    ///
    /// <p>The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or <i>All</i>. You must specify a value for this parameter or the <code>AccountIdsToRemove</code> parameter.</p>
    pub fn account_ids_to_add(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.account_ids_to_add.unwrap_or_default();
        v.push(input.into());
        self.account_ids_to_add = ::std::option::Option::Some(v);
        self
    }
    /// <p>The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or <i>All</i>. You must specify a value for this parameter or the <code>AccountIdsToRemove</code> parameter.</p>
    pub fn set_account_ids_to_add(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.account_ids_to_add = input;
        self
    }
    /// <p>The Amazon Web Services users that should have access to the document. The account IDs can either be a group of account IDs or <i>All</i>. You must specify a value for this parameter or the <code>AccountIdsToRemove</code> parameter.</p>
    pub fn get_account_ids_to_add(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.account_ids_to_add
    }
    /// Appends an item to `account_ids_to_remove`.
    ///
    /// To override the contents of this collection use [`set_account_ids_to_remove`](Self::set_account_ids_to_remove).
    ///
    /// <p>The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or <i>All</i>. This action has a higher priority than <code>AccountIdsToAdd</code>. If you specify an ID to add and the same ID to remove, the system removes access to the document. You must specify a value for this parameter or the <code>AccountIdsToAdd</code> parameter.</p>
    pub fn account_ids_to_remove(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.account_ids_to_remove.unwrap_or_default();
        v.push(input.into());
        self.account_ids_to_remove = ::std::option::Option::Some(v);
        self
    }
    /// <p>The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or <i>All</i>. This action has a higher priority than <code>AccountIdsToAdd</code>. If you specify an ID to add and the same ID to remove, the system removes access to the document. You must specify a value for this parameter or the <code>AccountIdsToAdd</code> parameter.</p>
    pub fn set_account_ids_to_remove(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.account_ids_to_remove = input;
        self
    }
    /// <p>The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user can either be a group of account IDs or <i>All</i>. This action has a higher priority than <code>AccountIdsToAdd</code>. If you specify an ID to add and the same ID to remove, the system removes access to the document. You must specify a value for this parameter or the <code>AccountIdsToAdd</code> parameter.</p>
    pub fn get_account_ids_to_remove(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.account_ids_to_remove
    }
    /// <p>(Optional) The version of the document to share. If it isn't specified, the system choose the <code>Default</code> version to share.</p>
    pub fn shared_document_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.shared_document_version = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>(Optional) The version of the document to share. If it isn't specified, the system choose the <code>Default</code> version to share.</p>
    pub fn set_shared_document_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.shared_document_version = input;
        self
    }
    /// <p>(Optional) The version of the document to share. If it isn't specified, the system choose the <code>Default</code> version to share.</p>
    pub fn get_shared_document_version(&self) -> &::std::option::Option<::std::string::String> {
        &self.shared_document_version
    }
    /// Consumes the builder and constructs a [`ModifyDocumentPermissionInput`](crate::operation::modify_document_permission::ModifyDocumentPermissionInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<
        crate::operation::modify_document_permission::ModifyDocumentPermissionInput,
        ::aws_smithy_types::error::operation::BuildError,
    > {
        ::std::result::Result::Ok(crate::operation::modify_document_permission::ModifyDocumentPermissionInput {
            name: self.name,
            permission_type: self.permission_type,
            account_ids_to_add: self.account_ids_to_add,
            account_ids_to_remove: self.account_ids_to_remove,
            shared_document_version: self.shared_document_version,
        })
    }
}