DocumentDescription class

Describes a Systems Manager document.

Constructors

DocumentDescription({String? approvedVersion, List<AttachmentInformation>? attachmentsInformation, String? author, DateTime? createdDate, String? defaultVersion, String? description, DocumentFormat? documentFormat, DocumentType? documentType, String? documentVersion, String? hash, DocumentHashType? hashType, String? latestVersion, String? name, String? owner, List<DocumentParameter>? parameters, String? pendingReviewVersion, List<PlatformType>? platformTypes, List<DocumentRequires>? requires, List<ReviewInformation>? reviewInformation, ReviewStatus? reviewStatus, String? schemaVersion, String? sha1, DocumentStatus? status, String? statusInformation, List<Tag>? tags, String? targetType, String? versionName})
DocumentDescription.fromJson(Map<String, dynamic> json)
factory

Properties

approvedVersion → String?
The version of the document currently approved for use in the organization.
final
attachmentsInformation → List<AttachmentInformation>?
Details about the document attachments, including names, locations, sizes, and so on.
final
author → String?
The user in your organization who created the document.
final
createdDate → DateTime?
The date when the document was created.
final
defaultVersion → String?
The default version.
final
description → String?
A description of the document.
final
documentFormat → DocumentFormat?
The document format, either JSON or YAML.
final
documentType → DocumentType?
The type of document.
final
documentVersion → String?
The document version.
final
hash → String?
The Sha256 or Sha1 hash created by the system when the document was created.
final
hashCode → int
The hash code for this object.
no setterinherited
hashType → DocumentHashType?
The hash type of the document. Valid values include Sha256 or Sha1.
final
latestVersion → String?
The latest version of the document.
final
name → String?
The name of the Systems Manager document.
final
owner → String?
The AWS user account that created the document.
final
parameters → List<DocumentParameter>?
A description of the parameters for a document.
final
pendingReviewVersion → String?
The version of the document that is currently under review.
final
platformTypes → List<PlatformType>?
The list of OS platforms compatible with this Systems Manager document.
final
requires → List<DocumentRequires>?
A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
final
reviewInformation → List<ReviewInformation>?
Details about the review of a document.
final
reviewStatus → ReviewStatus?
The current status of the review.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schemaVersion → String?
The schema version.
final
sha1 → String?
The SHA1 hash of the document, which you can use for verification.
final
status → DocumentStatus?
The status of the Systems Manager document.
final
statusInformation → String?
A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct."
final
tags → List<Tag>?
The tags, or metadata, that have been applied to the document.
final
targetType → 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 AWS resource and property types reference in the AWS CloudFormation User Guide.
final
versionName → String?
The version of the artifact associated with the document.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited