#[non_exhaustive]pub struct DocumentDescription {Show 30 fields
pub sha1: Option<String>,
pub hash: Option<String>,
pub hash_type: Option<DocumentHashType>,
pub name: Option<String>,
pub display_name: Option<String>,
pub version_name: Option<String>,
pub owner: Option<String>,
pub created_date: Option<DateTime>,
pub status: Option<DocumentStatus>,
pub status_information: Option<String>,
pub document_version: Option<String>,
pub description: Option<String>,
pub parameters: Option<Vec<DocumentParameter>>,
pub platform_types: Option<Vec<PlatformType>>,
pub document_type: Option<DocumentType>,
pub schema_version: Option<String>,
pub latest_version: Option<String>,
pub default_version: Option<String>,
pub document_format: Option<DocumentFormat>,
pub target_type: Option<String>,
pub tags: Option<Vec<Tag>>,
pub attachments_information: Option<Vec<AttachmentInformation>>,
pub requires: Option<Vec<DocumentRequires>>,
pub author: Option<String>,
pub review_information: Option<Vec<ReviewInformation>>,
pub approved_version: Option<String>,
pub pending_review_version: Option<String>,
pub review_status: Option<ReviewStatus>,
pub category: Option<Vec<String>>,
pub category_enum: Option<Vec<String>>,
}Expand description
Describes an Amazon Web Services Systems Manager document (SSM document).
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.sha1: Option<String>The SHA1 hash of the document, which you can use for verification.
hash: Option<String>The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
hash_type: Option<DocumentHashType>The hash type of the document. Valid values include Sha256 or Sha1.
Sha1 hashes have been deprecated.
name: Option<String>The name of the SSM document.
display_name: Option<String>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 UpdateDocument.
version_name: Option<String>The version of the artifact associated with the document.
owner: Option<String>The Amazon Web Services user that created the document.
created_date: Option<DateTime>The date when the document was created.
status: Option<DocumentStatus>The status of the SSM document.
status_information: Option<String>A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
document_version: Option<String>The document version.
description: Option<String>A description of the document.
parameters: Option<Vec<DocumentParameter>>A description of the parameters for a document.
platform_types: Option<Vec<PlatformType>>The list of operating system (OS) platforms compatible with this SSM document.
document_type: Option<DocumentType>The type of document.
schema_version: Option<String>The schema version.
latest_version: Option<String>The latest version of the document.
default_version: Option<String>The default version.
document_format: Option<DocumentFormat>The document format, either JSON or YAML.
target_type: Option<String>The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
The tags, or metadata, that have been applied to the document.
attachments_information: Option<Vec<AttachmentInformation>>Details about the document attachments, including names, locations, sizes, and so on.
requires: Option<Vec<DocumentRequires>>A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
The user in your organization who created the document.
review_information: Option<Vec<ReviewInformation>>Details about the review of a document.
approved_version: Option<String>The version of the document currently approved for use in the organization.
pending_review_version: Option<String>The version of the document that is currently under review.
review_status: Option<ReviewStatus>The current status of the review.
category: Option<Vec<String>>The classification of a document to help you identify and categorize its use.
category_enum: Option<Vec<String>>The value that identifies a document's category.
Implementations§
Source§impl DocumentDescription
impl DocumentDescription
Sourcepub fn sha1(&self) -> Option<&str>
pub fn sha1(&self) -> Option<&str>
The SHA1 hash of the document, which you can use for verification.
Sourcepub fn hash(&self) -> Option<&str>
pub fn hash(&self) -> Option<&str>
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
Sourcepub fn hash_type(&self) -> Option<&DocumentHashType>
pub fn hash_type(&self) -> Option<&DocumentHashType>
The hash type of the document. Valid values include Sha256 or Sha1.
Sha1 hashes have been deprecated.
Sourcepub fn display_name(&self) -> Option<&str>
pub fn display_name(&self) -> Option<&str>
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 UpdateDocument.
Sourcepub fn version_name(&self) -> Option<&str>
pub fn version_name(&self) -> Option<&str>
The version of the artifact associated with the document.
Sourcepub fn created_date(&self) -> Option<&DateTime>
pub fn created_date(&self) -> Option<&DateTime>
The date when the document was created.
Sourcepub fn status(&self) -> Option<&DocumentStatus>
pub fn status(&self) -> Option<&DocumentStatus>
The status of the SSM document.
Sourcepub fn status_information(&self) -> Option<&str>
pub fn status_information(&self) -> Option<&str>
A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
Sourcepub fn document_version(&self) -> Option<&str>
pub fn document_version(&self) -> Option<&str>
The document version.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A description of the document.
Sourcepub fn parameters(&self) -> &[DocumentParameter]
pub fn parameters(&self) -> &[DocumentParameter]
A description of the parameters for a document.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .parameters.is_none().
Sourcepub fn platform_types(&self) -> &[PlatformType]
pub fn platform_types(&self) -> &[PlatformType]
The list of operating system (OS) platforms compatible with this SSM document.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .platform_types.is_none().
Sourcepub fn document_type(&self) -> Option<&DocumentType>
pub fn document_type(&self) -> Option<&DocumentType>
The type of document.
Sourcepub fn schema_version(&self) -> Option<&str>
pub fn schema_version(&self) -> Option<&str>
The schema version.
Sourcepub fn latest_version(&self) -> Option<&str>
pub fn latest_version(&self) -> Option<&str>
The latest version of the document.
Sourcepub fn default_version(&self) -> Option<&str>
pub fn default_version(&self) -> Option<&str>
The default version.
Sourcepub fn document_format(&self) -> Option<&DocumentFormat>
pub fn document_format(&self) -> Option<&DocumentFormat>
The document format, either JSON or YAML.
Sourcepub fn target_type(&self) -> Option<&str>
pub fn target_type(&self) -> Option<&str>
The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
The tags, or metadata, that have been applied to the document.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().
Sourcepub fn attachments_information(&self) -> &[AttachmentInformation]
pub fn attachments_information(&self) -> &[AttachmentInformation]
Details about the document attachments, including names, locations, sizes, and so on.
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_information.is_none().
Sourcepub fn requires(&self) -> &[DocumentRequires]
pub fn requires(&self) -> &[DocumentRequires]
A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
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().
The user in your organization who created the document.
Sourcepub fn review_information(&self) -> &[ReviewInformation]
pub fn review_information(&self) -> &[ReviewInformation]
Details about the review of a document.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .review_information.is_none().
Sourcepub fn approved_version(&self) -> Option<&str>
pub fn approved_version(&self) -> Option<&str>
The version of the document currently approved for use in the organization.
Sourcepub fn pending_review_version(&self) -> Option<&str>
pub fn pending_review_version(&self) -> Option<&str>
The version of the document that is currently under review.
Sourcepub fn review_status(&self) -> Option<&ReviewStatus>
pub fn review_status(&self) -> Option<&ReviewStatus>
The current status of the review.
Sourcepub fn category(&self) -> &[String]
pub fn category(&self) -> &[String]
The classification of a document to help you identify and categorize its use.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .category.is_none().
Sourcepub fn category_enum(&self) -> &[String]
pub fn category_enum(&self) -> &[String]
The value that identifies a document's category.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .category_enum.is_none().
Source§impl DocumentDescription
impl DocumentDescription
Sourcepub fn builder() -> DocumentDescriptionBuilder
pub fn builder() -> DocumentDescriptionBuilder
Creates a new builder-style object to manufacture DocumentDescription.
Trait Implementations§
Source§impl Clone for DocumentDescription
impl Clone for DocumentDescription
Source§fn clone(&self) -> DocumentDescription
fn clone(&self) -> DocumentDescription
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for DocumentDescription
impl Debug for DocumentDescription
Source§impl PartialEq for DocumentDescription
impl PartialEq for DocumentDescription
impl StructuralPartialEq for DocumentDescription
Auto Trait Implementations§
impl Freeze for DocumentDescription
impl RefUnwindSafe for DocumentDescription
impl Send for DocumentDescription
impl Sync for DocumentDescription
impl Unpin for DocumentDescription
impl UnwindSafe for DocumentDescription
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);