aws_sdk_ssm/client/

update_document.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateDocument`](crate::operation::update_document::builders::UpdateDocumentFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`content(impl Into<String>)`](crate::operation::update_document::builders::UpdateDocumentFluentBuilder::content) / [`set_content(Option<String>)`](crate::operation::update_document::builders::UpdateDocumentFluentBuilder::set_content):<br>required: **true**<br><p>A valid JSON or YAML string.</p><br>
    ///   - [`attachments(AttachmentsSource)`](crate::operation::update_document::builders::UpdateDocumentFluentBuilder::attachments) / [`set_attachments(Option<Vec::<AttachmentsSource>>)`](crate::operation::update_document::builders::UpdateDocumentFluentBuilder::set_attachments):<br>required: **false**<br><p>A list of key-value pairs that describe attachments to a version of a document.</p><br>
    ///   - [`name(impl Into<String>)`](crate::operation::update_document::builders::UpdateDocumentFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_document::builders::UpdateDocumentFluentBuilder::set_name):<br>required: **true**<br><p>The name of the SSM document that you want to update.</p><br>
    ///   - [`display_name(impl Into<String>)`](crate::operation::update_document::builders::UpdateDocumentFluentBuilder::display_name) / [`set_display_name(Option<String>)`](crate::operation::update_document::builders::UpdateDocumentFluentBuilder::set_display_name):<br>required: **false**<br><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><br>
    ///   - [`version_name(impl Into<String>)`](crate::operation::update_document::builders::UpdateDocumentFluentBuilder::version_name) / [`set_version_name(Option<String>)`](crate::operation::update_document::builders::UpdateDocumentFluentBuilder::set_version_name):<br>required: **false**<br><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><br>
    ///   - [`document_version(impl Into<String>)`](crate::operation::update_document::builders::UpdateDocumentFluentBuilder::document_version) / [`set_document_version(Option<String>)`](crate::operation::update_document::builders::UpdateDocumentFluentBuilder::set_document_version):<br>required: **false**<br><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><br>
    ///   - [`document_format(DocumentFormat)`](crate::operation::update_document::builders::UpdateDocumentFluentBuilder::document_format) / [`set_document_format(Option<DocumentFormat>)`](crate::operation::update_document::builders::UpdateDocumentFluentBuilder::set_document_format):<br>required: **false**<br><p>Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.</p><br>
    ///   - [`target_type(impl Into<String>)`](crate::operation::update_document::builders::UpdateDocumentFluentBuilder::target_type) / [`set_target_type(Option<String>)`](crate::operation::update_document::builders::UpdateDocumentFluentBuilder::set_target_type):<br>required: **false**<br><p>Specify a new target type for the document.</p><br>
    /// - On success, responds with [`UpdateDocumentOutput`](crate::operation::update_document::UpdateDocumentOutput) with field(s):
    ///   - [`document_description(Option<DocumentDescription>)`](crate::operation::update_document::UpdateDocumentOutput::document_description): <p>A description of the document that was updated.</p>
    /// - On failure, responds with [`SdkError<UpdateDocumentError>`](crate::operation::update_document::UpdateDocumentError)
    pub fn update_document(&self) -> crate::operation::update_document::builders::UpdateDocumentFluentBuilder {
        crate::operation::update_document::builders::UpdateDocumentFluentBuilder::new(self.handle.clone())
    }
}