aws_sdk_ssm/client/
describe_document.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeDocument`](crate::operation::describe_document::builders::DescribeDocumentFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::describe_document::builders::DescribeDocumentFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::describe_document::builders::DescribeDocumentFluentBuilder::set_name):<br>required: **true**<br><p>The name of the SSM document.</p><note>  <p>If you're calling a shared SSM document from a different Amazon Web Services account, <code>Name</code> is the full Amazon Resource Name (ARN) of the document.</p> </note><br>
7    ///   - [`document_version(impl Into<String>)`](crate::operation::describe_document::builders::DescribeDocumentFluentBuilder::document_version) / [`set_document_version(Option<String>)`](crate::operation::describe_document::builders::DescribeDocumentFluentBuilder::set_document_version):<br>required: **false**<br><p>The document version for which you want information. Can be a specific version or the default version.</p><br>
8    ///   - [`version_name(impl Into<String>)`](crate::operation::describe_document::builders::DescribeDocumentFluentBuilder::version_name) / [`set_version_name(Option<String>)`](crate::operation::describe_document::builders::DescribeDocumentFluentBuilder::set_version_name):<br>required: **false**<br><p>An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.</p><br>
9    /// - On success, responds with [`DescribeDocumentOutput`](crate::operation::describe_document::DescribeDocumentOutput) with field(s):
10    ///   - [`document(Option<DocumentDescription>)`](crate::operation::describe_document::DescribeDocumentOutput::document): <p>Information about the SSM document.</p>
11    /// - On failure, responds with [`SdkError<DescribeDocumentError>`](crate::operation::describe_document::DescribeDocumentError)
12    pub fn describe_document(&self) -> crate::operation::describe_document::builders::DescribeDocumentFluentBuilder {
13        crate::operation::describe_document::builders::DescribeDocumentFluentBuilder::new(self.handle.clone())
14    }
15}
aws_sdk_ssm/client/describe_document.rs

aws_sdk_ssm/client/
describe_document.rs
