aws-sdk-ssm 1.131.0

// 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 UpdateDocumentInput {
    /// <p>A valid JSON or YAML string.</p>
    pub content: ::std::option::Option<::std::string::String>,
    /// <p>A list of key-value pairs that describe attachments to a version of a document.</p>
    pub attachments: ::std::option::Option<::std::vec::Vec<crate::types::AttachmentsSource>>,
    /// <p>The name of the SSM document that you want to update.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.</p>
    pub display_name: ::std::option::Option<::std::string::String>,
    /// <p>An optional field specifying the version of the artifact you are updating with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.</p>
    pub version_name: ::std::option::Option<::std::string::String>,
    /// <p>The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the <code>$LATEST</code> variable.</p><note>
    /// <p>If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the <code>apply-only-at-cron-interval</code> parameter.</p>
    /// </note>
    pub document_version: ::std::option::Option<::std::string::String>,
    /// <p>Specify the document format for the new document version. The document format can be JSON, YAML, or TEXT. JSON is the default format.</p>
    pub document_format: ::std::option::Option<crate::types::DocumentFormat>,
    /// <p>Specify a new target type for the document.</p>
    pub target_type: ::std::option::Option<::std::string::String>,
}
impl UpdateDocumentInput {
    /// <p>A valid JSON or YAML string.</p>
    pub fn content(&self) -> ::std::option::Option<&str> {
        self.content.as_deref()
    }
    /// <p>A list of key-value pairs that describe attachments to a version of a document.</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 `.attachments.is_none()`.
    pub fn attachments(&self) -> &[crate::types::AttachmentsSource] {
        self.attachments.as_deref().unwrap_or_default()
    }
    /// <p>The name of the SSM document that you want to update.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.</p>
    pub fn display_name(&self) -> ::std::option::Option<&str> {
        self.display_name.as_deref()
    }
    /// <p>An optional field specifying the version of the artifact you are updating with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.</p>
    pub fn version_name(&self) -> ::std::option::Option<&str> {
        self.version_name.as_deref()
    }
    /// <p>The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the <code>$LATEST</code> variable.</p><note>
    /// <p>If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the <code>apply-only-at-cron-interval</code> parameter.</p>
    /// </note>
    pub fn document_version(&self) -> ::std::option::Option<&str> {
        self.document_version.as_deref()
    }
    /// <p>Specify the document format for the new document version. The document format can be JSON, YAML, or TEXT. JSON is the default format.</p>
    pub fn document_format(&self) -> ::std::option::Option<&crate::types::DocumentFormat> {
        self.document_format.as_ref()
    }
    /// <p>Specify a new target type for the document.</p>
    pub fn target_type(&self) -> ::std::option::Option<&str> {
        self.target_type.as_deref()
    }
}
static UPDATEDOCUMENTINPUT_MEMBER_CONTENT: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#UpdateDocumentInput$Content",
        "com.amazonaws.ssm.synthetic",
        "UpdateDocumentInput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "Content",
    0,
);
static UPDATEDOCUMENTINPUT_MEMBER_ATTACHMENTS_MEMBER: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm#AttachmentsSourceList$member",
        "com.amazonaws.ssm",
        "AttachmentsSourceList",
    ),
    ::aws_smithy_schema::ShapeType::Structure,
    "member",
    0,
);
static UPDATEDOCUMENTINPUT_MEMBER_ATTACHMENTS: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#UpdateDocumentInput$Attachments",
        "com.amazonaws.ssm.synthetic",
        "UpdateDocumentInput",
    ),
    ::aws_smithy_schema::ShapeType::List,
    "Attachments",
    1,
)
.with_list_member(&UPDATEDOCUMENTINPUT_MEMBER_ATTACHMENTS_MEMBER);
static UPDATEDOCUMENTINPUT_MEMBER_NAME: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#UpdateDocumentInput$Name",
        "com.amazonaws.ssm.synthetic",
        "UpdateDocumentInput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "Name",
    2,
);
static UPDATEDOCUMENTINPUT_MEMBER_DISPLAY_NAME: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#UpdateDocumentInput$DisplayName",
        "com.amazonaws.ssm.synthetic",
        "UpdateDocumentInput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "DisplayName",
    3,
);
static UPDATEDOCUMENTINPUT_MEMBER_VERSION_NAME: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#UpdateDocumentInput$VersionName",
        "com.amazonaws.ssm.synthetic",
        "UpdateDocumentInput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "VersionName",
    4,
);
static UPDATEDOCUMENTINPUT_MEMBER_DOCUMENT_VERSION: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#UpdateDocumentInput$DocumentVersion",
        "com.amazonaws.ssm.synthetic",
        "UpdateDocumentInput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "DocumentVersion",
    5,
);
static UPDATEDOCUMENTINPUT_MEMBER_DOCUMENT_FORMAT: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#UpdateDocumentInput$DocumentFormat",
        "com.amazonaws.ssm.synthetic",
        "UpdateDocumentInput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "DocumentFormat",
    6,
);
static UPDATEDOCUMENTINPUT_MEMBER_TARGET_TYPE: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#UpdateDocumentInput$TargetType",
        "com.amazonaws.ssm.synthetic",
        "UpdateDocumentInput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "TargetType",
    7,
);
static UPDATEDOCUMENTINPUT_SCHEMA: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_struct(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#UpdateDocumentInput",
        "com.amazonaws.ssm.synthetic",
        "UpdateDocumentInput",
    ),
    ::aws_smithy_schema::ShapeType::Structure,
    &[
        &UPDATEDOCUMENTINPUT_MEMBER_CONTENT,
        &UPDATEDOCUMENTINPUT_MEMBER_ATTACHMENTS,
        &UPDATEDOCUMENTINPUT_MEMBER_NAME,
        &UPDATEDOCUMENTINPUT_MEMBER_DISPLAY_NAME,
        &UPDATEDOCUMENTINPUT_MEMBER_VERSION_NAME,
        &UPDATEDOCUMENTINPUT_MEMBER_DOCUMENT_VERSION,
        &UPDATEDOCUMENTINPUT_MEMBER_DOCUMENT_FORMAT,
        &UPDATEDOCUMENTINPUT_MEMBER_TARGET_TYPE,
    ],
)
.with_payload_hint(::aws_smithy_schema::PayloadHint::NoStructPayload)
.with_original_name("UpdateDocumentRequest");
impl UpdateDocumentInput {
    /// The schema for this shape.
    pub const SCHEMA: &'static ::aws_smithy_schema::Schema<'static> = &UPDATEDOCUMENTINPUT_SCHEMA;
}
impl ::aws_smithy_schema::serde::SerializableStruct for UpdateDocumentInput {
    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.content {
            ser.write_string(&UPDATEDOCUMENTINPUT_MEMBER_CONTENT, val)?;
        }
        if let Some(ref val) = self.attachments {
            ser.write_list(
                &UPDATEDOCUMENTINPUT_MEMBER_ATTACHMENTS,
                &|ser: &mut dyn ::aws_smithy_schema::serde::ShapeSerializer| {
                    for item in val {
                        ser.write_struct(crate::types::AttachmentsSource::SCHEMA, item)?;
                    }
                    Ok(())
                },
            )?;
        }
        if let Some(ref val) = self.name {
            ser.write_string(&UPDATEDOCUMENTINPUT_MEMBER_NAME, val)?;
        }
        if let Some(ref val) = self.display_name {
            ser.write_string(&UPDATEDOCUMENTINPUT_MEMBER_DISPLAY_NAME, val)?;
        }
        if let Some(ref val) = self.version_name {
            ser.write_string(&UPDATEDOCUMENTINPUT_MEMBER_VERSION_NAME, val)?;
        }
        if let Some(ref val) = self.document_version {
            ser.write_string(&UPDATEDOCUMENTINPUT_MEMBER_DOCUMENT_VERSION, val)?;
        }
        if let Some(ref val) = self.document_format {
            ser.write_string(&UPDATEDOCUMENTINPUT_MEMBER_DOCUMENT_FORMAT, val.as_str())?;
        }
        if let Some(ref val) = self.target_type {
            ser.write_string(&UPDATEDOCUMENTINPUT_MEMBER_TARGET_TYPE, val)?;
        }
        Ok(())
    }
}
impl crate::operation::update_document::builders::UpdateDocumentInputBuilder {
    #[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(&UPDATEDOCUMENTINPUT_SCHEMA, &mut |member, deser| {
            match member.member_index() {
                Some(0) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.content = Some(deser.read_string(member)?);
                    }
                }
                Some(1) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.attachments = Some({
                            let mut container = Vec::new();
                            deser.read_list(member, &mut |deser| {
                                container.push(crate::types::AttachmentsSource::deserialize(deser)?);
                                Ok(())
                            })?;
                            container
                        });
                    }
                }
                Some(2) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.name = Some(deser.read_string(member)?);
                    }
                }
                Some(3) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.display_name = Some(deser.read_string(member)?);
                    }
                }
                Some(4) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.version_name = Some(deser.read_string(member)?);
                    }
                }
                Some(5) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.document_version = Some(deser.read_string(member)?);
                    }
                }
                Some(6) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.document_format = Some(crate::types::DocumentFormat::from(deser.read_string(member)?.as_str()));
                    }
                }
                Some(7) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.target_type = Some(deser.read_string(member)?);
                    }
                }
                _ => {}
            }
            Ok(())
        })
    }
}

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

/// A builder for [`UpdateDocumentInput`](crate::operation::update_document::UpdateDocumentInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct UpdateDocumentInputBuilder {
    pub(crate) content: ::std::option::Option<::std::string::String>,
    pub(crate) attachments: ::std::option::Option<::std::vec::Vec<crate::types::AttachmentsSource>>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) display_name: ::std::option::Option<::std::string::String>,
    pub(crate) version_name: ::std::option::Option<::std::string::String>,
    pub(crate) document_version: ::std::option::Option<::std::string::String>,
    pub(crate) document_format: ::std::option::Option<crate::types::DocumentFormat>,
    pub(crate) target_type: ::std::option::Option<::std::string::String>,
}
impl UpdateDocumentInputBuilder {
    /// <p>A valid JSON or YAML string.</p>
    /// This field is required.
    pub fn content(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.content = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A valid JSON or YAML string.</p>
    pub fn set_content(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.content = input;
        self
    }
    /// <p>A valid JSON or YAML string.</p>
    pub fn get_content(&self) -> &::std::option::Option<::std::string::String> {
        &self.content
    }
    /// Appends an item to `attachments`.
    ///
    /// To override the contents of this collection use [`set_attachments`](Self::set_attachments).
    ///
    /// <p>A list of key-value pairs that describe attachments to a version of a document.</p>
    pub fn attachments(mut self, input: crate::types::AttachmentsSource) -> Self {
        let mut v = self.attachments.unwrap_or_default();
        v.push(input);
        self.attachments = ::std::option::Option::Some(v);
        self
    }
    /// <p>A list of key-value pairs that describe attachments to a version of a document.</p>
    pub fn set_attachments(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AttachmentsSource>>) -> Self {
        self.attachments = input;
        self
    }
    /// <p>A list of key-value pairs that describe attachments to a version of a document.</p>
    pub fn get_attachments(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AttachmentsSource>> {
        &self.attachments
    }
    /// <p>The name of the SSM document that you want to update.</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 SSM document that you want to update.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the SSM document that you want to update.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.</p>
    pub fn display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.display_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.</p>
    pub fn set_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.display_name = input;
        self
    }
    /// <p>The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.</p>
    pub fn get_display_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.display_name
    }
    /// <p>An optional field specifying the version of the artifact you are updating with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.</p>
    pub fn version_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.version_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>An optional field specifying the version of the artifact you are updating with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.</p>
    pub fn set_version_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.version_name = input;
        self
    }
    /// <p>An optional field specifying the version of the artifact you are updating with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.</p>
    pub fn get_version_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.version_name
    }
    /// <p>The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the <code>$LATEST</code> variable.</p><note>
    /// <p>If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the <code>apply-only-at-cron-interval</code> parameter.</p>
    /// </note>
    pub fn document_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.document_version = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the <code>$LATEST</code> variable.</p><note>
    /// <p>If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the <code>apply-only-at-cron-interval</code> parameter.</p>
    /// </note>
    pub fn set_document_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.document_version = input;
        self
    }
    /// <p>The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the <code>$LATEST</code> variable.</p><note>
    /// <p>If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the <code>apply-only-at-cron-interval</code> parameter.</p>
    /// </note>
    pub fn get_document_version(&self) -> &::std::option::Option<::std::string::String> {
        &self.document_version
    }
    /// <p>Specify the document format for the new document version. The document format can be JSON, YAML, or TEXT. JSON is the default format.</p>
    pub fn document_format(mut self, input: crate::types::DocumentFormat) -> Self {
        self.document_format = ::std::option::Option::Some(input);
        self
    }
    /// <p>Specify the document format for the new document version. The document format can be JSON, YAML, or TEXT. JSON is the default format.</p>
    pub fn set_document_format(mut self, input: ::std::option::Option<crate::types::DocumentFormat>) -> Self {
        self.document_format = input;
        self
    }
    /// <p>Specify the document format for the new document version. The document format can be JSON, YAML, or TEXT. JSON is the default format.</p>
    pub fn get_document_format(&self) -> &::std::option::Option<crate::types::DocumentFormat> {
        &self.document_format
    }
    /// <p>Specify a new target type for the document.</p>
    pub fn target_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.target_type = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Specify a new target type for the document.</p>
    pub fn set_target_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.target_type = input;
        self
    }
    /// <p>Specify a new target type for the document.</p>
    pub fn get_target_type(&self) -> &::std::option::Option<::std::string::String> {
        &self.target_type
    }
    /// Consumes the builder and constructs a [`UpdateDocumentInput`](crate::operation::update_document::UpdateDocumentInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::update_document::UpdateDocumentInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::update_document::UpdateDocumentInput {
            content: self.content,
            attachments: self.attachments,
            name: self.name,
            display_name: self.display_name,
            version_name: self.version_name,
            document_version: self.document_version,
            document_format: self.document_format,
            target_type: self.target_type,
        })
    }
}