1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
// 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 GetDocumentOutput {
/// <p>The name of the SSM document.</p>
pub name: ::std::option::Option<::std::string::String>,
/// <p>The date the SSM document was created.</p>
pub created_date: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see <code>UpdateDocument</code>.</p>
pub display_name: ::std::option::Option<::std::string::String>,
/// <p>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>
pub version_name: ::std::option::Option<::std::string::String>,
/// <p>The document version.</p>
pub document_version: ::std::option::Option<::std::string::String>,
/// <p>The status of the SSM document, such as <code>Creating</code>, <code>Active</code>, <code>Updating</code>, <code>Failed</code>, and <code>Deleting</code>.</p>
pub status: ::std::option::Option<crate::types::DocumentStatus>,
/// <p>A message returned by Amazon Web Services Systems Manager that explains the <code>Status</code> value. For example, a <code>Failed</code> status might be explained by the <code>StatusInformation</code> message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."</p>
pub status_information: ::std::option::Option<::std::string::String>,
/// <p>The contents of the SSM document.</p>
pub content: ::std::option::Option<::std::string::String>,
/// <p>The document type.</p>
pub document_type: ::std::option::Option<crate::types::DocumentType>,
/// <p>The document format, either JSON or YAML.</p>
pub document_format: ::std::option::Option<crate::types::DocumentFormat>,
/// <p>A list of SSM documents required by a document. For example, an <code>ApplicationConfiguration</code> document requires an <code>ApplicationConfigurationSchema</code> document.</p>
pub requires: ::std::option::Option<::std::vec::Vec<crate::types::DocumentRequires>>,
/// <p>A description of the document attachments, including names, locations, sizes, and so on.</p>
pub attachments_content: ::std::option::Option<::std::vec::Vec<crate::types::AttachmentContent>>,
/// <p>The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.</p>
/// <p>Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.</p>
/// <p>Only one version of an SSM document can be in review, or PENDING, at a time.</p>
pub review_status: ::std::option::Option<crate::types::ReviewStatus>,
_request_id: Option<String>,
}
impl GetDocumentOutput {
/// <p>The name of the SSM document.</p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>The date the SSM document was created.</p>
pub fn created_date(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.created_date.as_ref()
}
/// <p>The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see <code>UpdateDocument</code>.</p>
pub fn display_name(&self) -> ::std::option::Option<&str> {
self.display_name.as_deref()
}
/// <p>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>
pub fn version_name(&self) -> ::std::option::Option<&str> {
self.version_name.as_deref()
}
/// <p>The document version.</p>
pub fn document_version(&self) -> ::std::option::Option<&str> {
self.document_version.as_deref()
}
/// <p>The status of the SSM document, such as <code>Creating</code>, <code>Active</code>, <code>Updating</code>, <code>Failed</code>, and <code>Deleting</code>.</p>
pub fn status(&self) -> ::std::option::Option<&crate::types::DocumentStatus> {
self.status.as_ref()
}
/// <p>A message returned by Amazon Web Services Systems Manager that explains the <code>Status</code> value. For example, a <code>Failed</code> status might be explained by the <code>StatusInformation</code> message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."</p>
pub fn status_information(&self) -> ::std::option::Option<&str> {
self.status_information.as_deref()
}
/// <p>The contents of the SSM document.</p>
pub fn content(&self) -> ::std::option::Option<&str> {
self.content.as_deref()
}
/// <p>The document type.</p>
pub fn document_type(&self) -> ::std::option::Option<&crate::types::DocumentType> {
self.document_type.as_ref()
}
/// <p>The document format, either JSON or YAML.</p>
pub fn document_format(&self) -> ::std::option::Option<&crate::types::DocumentFormat> {
self.document_format.as_ref()
}
/// <p>A list of SSM documents required by a document. For example, an <code>ApplicationConfiguration</code> document requires an <code>ApplicationConfigurationSchema</code> 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 `.requires.is_none()`.
pub fn requires(&self) -> &[crate::types::DocumentRequires] {
self.requires.as_deref().unwrap_or_default()
}
/// <p>A description of the document attachments, including names, locations, sizes, and so on.</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_content.is_none()`.
pub fn attachments_content(&self) -> &[crate::types::AttachmentContent] {
self.attachments_content.as_deref().unwrap_or_default()
}
/// <p>The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.</p>
/// <p>Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.</p>
/// <p>Only one version of an SSM document can be in review, or PENDING, at a time.</p>
pub fn review_status(&self) -> ::std::option::Option<&crate::types::ReviewStatus> {
self.review_status.as_ref()
}
}
impl ::aws_types::request_id::RequestId for GetDocumentOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl GetDocumentOutput {
/// Creates a new builder-style object to manufacture [`GetDocumentOutput`](crate::operation::get_document::GetDocumentOutput).
pub fn builder() -> crate::operation::get_document::builders::GetDocumentOutputBuilder {
crate::operation::get_document::builders::GetDocumentOutputBuilder::default()
}
}
/// A builder for [`GetDocumentOutput`](crate::operation::get_document::GetDocumentOutput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct GetDocumentOutputBuilder {
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) created_date: ::std::option::Option<::aws_smithy_types::DateTime>,
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) status: ::std::option::Option<crate::types::DocumentStatus>,
pub(crate) status_information: ::std::option::Option<::std::string::String>,
pub(crate) content: ::std::option::Option<::std::string::String>,
pub(crate) document_type: ::std::option::Option<crate::types::DocumentType>,
pub(crate) document_format: ::std::option::Option<crate::types::DocumentFormat>,
pub(crate) requires: ::std::option::Option<::std::vec::Vec<crate::types::DocumentRequires>>,
pub(crate) attachments_content: ::std::option::Option<::std::vec::Vec<crate::types::AttachmentContent>>,
pub(crate) review_status: ::std::option::Option<crate::types::ReviewStatus>,
_request_id: Option<String>,
}
impl GetDocumentOutputBuilder {
/// <p>The name of the SSM document.</p>
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.</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.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <p>The date the SSM document was created.</p>
pub fn created_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.created_date = ::std::option::Option::Some(input);
self
}
/// <p>The date the SSM document was created.</p>
pub fn set_created_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.created_date = input;
self
}
/// <p>The date the SSM document was created.</p>
pub fn get_created_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.created_date
}
/// <p>The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see <code>UpdateDocument</code>.</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. This value can differ for each version of the document. If you want to update this value, see <code>UpdateDocument</code>.</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. This value can differ for each version of the document. If you want to update this value, see <code>UpdateDocument</code>.</p>
pub fn get_display_name(&self) -> &::std::option::Option<::std::string::String> {
&self.display_name
}
/// <p>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>
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>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>
pub fn set_version_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.version_name = input;
self
}
/// <p>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>
pub fn get_version_name(&self) -> &::std::option::Option<::std::string::String> {
&self.version_name
}
/// <p>The document version.</p>
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 document version.</p>
pub fn set_document_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.document_version = input;
self
}
/// <p>The document version.</p>
pub fn get_document_version(&self) -> &::std::option::Option<::std::string::String> {
&self.document_version
}
/// <p>The status of the SSM document, such as <code>Creating</code>, <code>Active</code>, <code>Updating</code>, <code>Failed</code>, and <code>Deleting</code>.</p>
pub fn status(mut self, input: crate::types::DocumentStatus) -> Self {
self.status = ::std::option::Option::Some(input);
self
}
/// <p>The status of the SSM document, such as <code>Creating</code>, <code>Active</code>, <code>Updating</code>, <code>Failed</code>, and <code>Deleting</code>.</p>
pub fn set_status(mut self, input: ::std::option::Option<crate::types::DocumentStatus>) -> Self {
self.status = input;
self
}
/// <p>The status of the SSM document, such as <code>Creating</code>, <code>Active</code>, <code>Updating</code>, <code>Failed</code>, and <code>Deleting</code>.</p>
pub fn get_status(&self) -> &::std::option::Option<crate::types::DocumentStatus> {
&self.status
}
/// <p>A message returned by Amazon Web Services Systems Manager that explains the <code>Status</code> value. For example, a <code>Failed</code> status might be explained by the <code>StatusInformation</code> message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."</p>
pub fn status_information(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.status_information = ::std::option::Option::Some(input.into());
self
}
/// <p>A message returned by Amazon Web Services Systems Manager that explains the <code>Status</code> value. For example, a <code>Failed</code> status might be explained by the <code>StatusInformation</code> message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."</p>
pub fn set_status_information(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.status_information = input;
self
}
/// <p>A message returned by Amazon Web Services Systems Manager that explains the <code>Status</code> value. For example, a <code>Failed</code> status might be explained by the <code>StatusInformation</code> message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."</p>
pub fn get_status_information(&self) -> &::std::option::Option<::std::string::String> {
&self.status_information
}
/// <p>The contents of the SSM document.</p>
pub fn content(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.content = ::std::option::Option::Some(input.into());
self
}
/// <p>The contents of the SSM document.</p>
pub fn set_content(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.content = input;
self
}
/// <p>The contents of the SSM document.</p>
pub fn get_content(&self) -> &::std::option::Option<::std::string::String> {
&self.content
}
/// <p>The document type.</p>
pub fn document_type(mut self, input: crate::types::DocumentType) -> Self {
self.document_type = ::std::option::Option::Some(input);
self
}
/// <p>The document type.</p>
pub fn set_document_type(mut self, input: ::std::option::Option<crate::types::DocumentType>) -> Self {
self.document_type = input;
self
}
/// <p>The document type.</p>
pub fn get_document_type(&self) -> &::std::option::Option<crate::types::DocumentType> {
&self.document_type
}
/// <p>The document format, either JSON or YAML.</p>
pub fn document_format(mut self, input: crate::types::DocumentFormat) -> Self {
self.document_format = ::std::option::Option::Some(input);
self
}
/// <p>The document format, either JSON or YAML.</p>
pub fn set_document_format(mut self, input: ::std::option::Option<crate::types::DocumentFormat>) -> Self {
self.document_format = input;
self
}
/// <p>The document format, either JSON or YAML.</p>
pub fn get_document_format(&self) -> &::std::option::Option<crate::types::DocumentFormat> {
&self.document_format
}
/// Appends an item to `requires`.
///
/// To override the contents of this collection use [`set_requires`](Self::set_requires).
///
/// <p>A list of SSM documents required by a document. For example, an <code>ApplicationConfiguration</code> document requires an <code>ApplicationConfigurationSchema</code> document.</p>
pub fn requires(mut self, input: crate::types::DocumentRequires) -> Self {
let mut v = self.requires.unwrap_or_default();
v.push(input);
self.requires = ::std::option::Option::Some(v);
self
}
/// <p>A list of SSM documents required by a document. For example, an <code>ApplicationConfiguration</code> document requires an <code>ApplicationConfigurationSchema</code> document.</p>
pub fn set_requires(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::DocumentRequires>>) -> Self {
self.requires = input;
self
}
/// <p>A list of SSM documents required by a document. For example, an <code>ApplicationConfiguration</code> document requires an <code>ApplicationConfigurationSchema</code> document.</p>
pub fn get_requires(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::DocumentRequires>> {
&self.requires
}
/// Appends an item to `attachments_content`.
///
/// To override the contents of this collection use [`set_attachments_content`](Self::set_attachments_content).
///
/// <p>A description of the document attachments, including names, locations, sizes, and so on.</p>
pub fn attachments_content(mut self, input: crate::types::AttachmentContent) -> Self {
let mut v = self.attachments_content.unwrap_or_default();
v.push(input);
self.attachments_content = ::std::option::Option::Some(v);
self
}
/// <p>A description of the document attachments, including names, locations, sizes, and so on.</p>
pub fn set_attachments_content(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AttachmentContent>>) -> Self {
self.attachments_content = input;
self
}
/// <p>A description of the document attachments, including names, locations, sizes, and so on.</p>
pub fn get_attachments_content(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AttachmentContent>> {
&self.attachments_content
}
/// <p>The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.</p>
/// <p>Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.</p>
/// <p>Only one version of an SSM document can be in review, or PENDING, at a time.</p>
pub fn review_status(mut self, input: crate::types::ReviewStatus) -> Self {
self.review_status = ::std::option::Option::Some(input);
self
}
/// <p>The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.</p>
/// <p>Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.</p>
/// <p>Only one version of an SSM document can be in review, or PENDING, at a time.</p>
pub fn set_review_status(mut self, input: ::std::option::Option<crate::types::ReviewStatus>) -> Self {
self.review_status = input;
self
}
/// <p>The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.</p>
/// <p>Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.</p>
/// <p>Only one version of an SSM document can be in review, or PENDING, at a time.</p>
pub fn get_review_status(&self) -> &::std::option::Option<crate::types::ReviewStatus> {
&self.review_status
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`GetDocumentOutput`](crate::operation::get_document::GetDocumentOutput).
pub fn build(self) -> crate::operation::get_document::GetDocumentOutput {
crate::operation::get_document::GetDocumentOutput {
name: self.name,
created_date: self.created_date,
display_name: self.display_name,
version_name: self.version_name,
document_version: self.document_version,
status: self.status,
status_information: self.status_information,
content: self.content,
document_type: self.document_type,
document_format: self.document_format,
requires: self.requires,
attachments_content: self.attachments_content,
review_status: self.review_status,
_request_id: self._request_id,
}
}
}